Skip to main content

List Approval Requests

GET 
/api/approval-requests

The approvals queue: paginated approval requests across purchase orders, vendor deposits and bill payments.

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). Authority comes from the policy, not a role permission — anyone can call this endpoint, and what they see depends on filter[view].

Row fields: document_type, document_id, document_number, document_title, document_url (app path of the document), supplier, status, reason (initial, reapproval_total_increased, reapproval_supplier_changed, reapproval_currency_changed, reapproval_lines_added, reapproval_payee_changed, reroute) with reason_label, amount (document amount + currency and base amount + base currency), tier_name, the current step (order, name, total; null once decided), waiting_on[] (users who can act now), waiting_since, awaiting_viewer (you can act on it now), requester, completion, self_approved, overridden, escalated_at (reminders ran out and administrators were alerted).

Filters, sorts and pagination are listed on the query parameters. Every list filter can also be combined in filter_groups.

Request​

Responses​

OK

Response Headers
    Content-Type