Skip to content

Approvals API

12 endpoints. All requests need an Authorization header — see Authentication. API keys additionally need the matching scope.

Method Path Description
GET /api/approval-rules/ List Rules Query: entity_type, is_active.
POST /api/approval-rules/ Create Rule Accepts a JSON body.
GET /api/approval-rules/fields List Fields
PATCH /api/approval-rules/{rule_id} Update Rule Accepts a JSON body.
DELETE /api/approval-rules/{rule_id} Delete Rule
GET /api/approvals/ List Approvals Query: entity_type, status, limit, offset.
POST /api/approvals/ Create Approval Accepts a JSON body.
POST /api/approvals/bulk-decide Bulk Decide Accepts a JSON body.
GET /api/approvals/pending My Pending Approvals
GET /api/approvals/{approval_id} Get Approval
POST /api/approvals/{approval_id}/decide Decide Approval Accepts a JSON body.
POST /api/approvals/{approval_id}/delegate Delegate Approval Accepts a JSON body.

Try it

The full request/response schema for every endpoint is in the OpenAPI spec served by your own workspace.