Skip to main content

Get Approval Request

GET 
/api/approval-requests/:approvalRequest

Get one approval request with its steps, every decision, who can act on each open step, and what the signed-in user may do with it.

Required scope: purchase-orders:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token with the purchase-orders scope (read for GET, write for POST/PUT/DELETE).

Response fields (in addition to the queue row fields):

  • amount.rate — document-to-base currency rate captured when the request was raised
  • tier — id, name, up_to_amount (as configured when the request was raised)
  • request_notes, current_step_order, waiting_on (names), last_reminded_at, reminder_count, superseded_by_id (the newer request that replaced this one)
  • steps[] — order, name, required_approvals, distinct_from_previous_steps, status (waiting → pending → approved | rejected), started_at, completed_at, approvers (as configured: type, id, name), eligible_users (open steps only, same shape as the routing preview), decisions[] (decision approved | rejected | override_approved, user, on_behalf_of when a delegate acted, satisfies_step_orders, self_approved, overridden, notes, created_at)
  • capabilities — for the signed-in user: can_approve, can_reject, can_withdraw (requester or administrator, before any approval), can_remind (requester or administrator, outside the 4-hour cooldown), can_override (administrator who is not otherwise eligible), can_reroute (administrator), blocked_reason

Request​

Responses​

OK

Response Headers
    Content-Type