Get an approval step
Platform module
GET/approval-steps/{id}approvalSteps.get
An ordered step of an approval policy (1030). It names its approvers: everyone holding a role, or one member. Steps change only while the policy is a Draft (approval_step_policy_not_draft: 422). Returns one approval step with its `ETag`. A approval step the caller may not see returns 404.
- Requires the capability org.settings.read.
- OAuth scopes: org.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the approval step. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: ApprovalStep
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the approval step. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row. |
| approval_policy_id | string (uuid) | Yes | Identifier of the approval policy. |
| step_order | integer | Yes | Position of the step, 1 first; steps are decided in order.Constraints: range 1 to any |
| name | string | Yes | Step name.Constraints: length 1 to 200 |
| approver_role_id | string (uuid) | null | Yes | Identifier of the role whose holders decide the step. |
| approver_membership_id | string (uuid) | null | Yes | Identifier of the the one member who decides the step. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"approval_policy_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"step_order": 1,
"name": "Department head",
"approver_role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"approver_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X GET "$XOS_BASE_URL/approval-steps/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.approvalSteps.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.approval_steps.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos approval-steps get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f