Get Document Approval

GET 
/api/approval-requests/for/:documentType/:documentId

The approval state of one document: whether its policy is enabled, the request that currently governs it (the pending one, else the latest approved one) with full detail and your capabilities, every earlier request, and — when there is no current request — a routing preview of where an approval request for the document would go.

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:

• policy_enabled
• current — full approval request (see Get Approval Request) or null
• history[] — earlier requests, newest first (capabilities is null and eligible_users empty on these)
• preview — routing preview (see Preview Approval Routing) when current is null and the policy is enabled, else null

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.