Approvals

List account and sale order approvals, read one, and approve or reject a pending approval.

Approvals hold an action until someone signs it off. You can list account and sale order approvals, read one account approval, and approve or reject a pending one. This area has 5 endpoints, and all seven SDKs call every one.

Approving or rejecting takes effect at once. An approve runs the held action, and both send notifications.

At a glance

Endpoint	Method	Path	What it does
List account approvals	GET	/approvals/account	Lists the account approvals, one page at a time.
List sale order approvals	GET	/approvals/saleOrder	Lists the sale order approvals, one page at a time.
Retrieve an account approval	GET	/approvals/account/{account_uuid}	Retrieves one account approval.
Approve a pending approval	POST	/approvals/approve	Approves a pending approval and runs the action it holds.
Reject a pending approval	POST	/approvals/reject	Rejects a pending approval.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• Approve and reject name the record in the body. Send {"approval": {"entity": "account", "resource_id": "ACC0001", "note": "Checked."}}; the same two routes serve every entity that can need approval.
• The sale order listing path is camel case. It is /approvals/saleOrder, not sale_order.
• Listings page by cursor. Records sit under data; pass pagination.next_cursor as cursor to read the next page, and stop when pagination.has_more is false.