Skip to content

Get an approval decision

Platform module

GET/approval-decisions/{id}approvalDecisions.get

A decision by an eligible approver, never the requester. Returns one approval decision with its `ETag`. A approval decision the caller may not see returns 404.

  • Requires the capability inbox.notifications.read.
  • OAuth scopes: inbox.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

approvalDecisions.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the approval decision.
fieldsFieldsNoSparse 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: ApprovalDecision

approvalDecisions.get: ApprovalDecision
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the approval decision.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
approval_instance_idstring (uuid)YesIdentifier of the approval instance.
approvedbooleanYesWhether the step is approved.
commentstring | nullYesDecision comment.Constraints: length 1 to 20000
approver_idstring (uuid)YesIdentifier of the approver.
decided_atstring (date-time)YesWhen it was decided.
step_orderintegerYesStep decided.Constraints: range 1 to any
{
  "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_instance_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "approved": true,
  "comment": "Within budget.",
  "approver_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "decided_at": "2026-10-08T14:30:00Z",
  "step_order": 1
}

Code samples

curl -X GET "$XOS_BASE_URL/approval-decisions/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.approvalDecisions.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.approval_decisions.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos approval-decisions get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f