Approvals API
Manage approval workflows for high-value or sensitive operations.
Approval Requests
List Approval Requests
GET /api/v1/approval-request
List all approval requests.
| Query | Type | Description |
|---|---|---|
status | string | PENDING, APPROVED, REJECTED, EXPIRED |
type | string | Request type filter |
offset | number | Pagination offset |
limit | number | Page size |
Get Approval Request
GET /api/v1/approval-request/{id}
Get detailed information about a specific approval request.
Get Approval Request Status
GET /api/v1/approval-request/{id}/status
Get the current voting status and remaining votes needed.
Count Approval Requests
GET /api/v1/approval-request/count
Get the count of approval requests by status.
Vote on Approval Request
POST /api/v1/approval-request/{id}/vote
Submit a vote (approve or reject) on a pending approval request.
| Field | Type | Required | Description |
|---|---|---|---|
decision | string | Yes | APPROVE or REJECT |
reason | string | No | Reason for the decision |
Bulk Vote
POST /api/v1/approval-request/bulk-vote
Vote on multiple approval requests at once.
| Field | Type | Required | Description |
|---|---|---|---|
requestIds | UUID[] | Yes | List of approval request IDs |
decision | string | Yes | APPROVE or REJECT |
reason | string | No | Reason for the decision |
Approval Settings
Get Approval Settings
GET /api/v1/approval-settings
Get the current approval configuration (thresholds, required votes, etc.).
Create or Update Approval Settings
PUT /api/v1/approval-settings
Configure approval requirements for different operation types.
| Field | Type | Required | Description |
|---|---|---|---|
operationType | string | Yes | Operation type requiring approval |
requiredVotes | number | Yes | Number of votes required |
threshold | number | No | Amount threshold above which approval is required |
approvers | UUID[] | Yes | List of authorized approver user IDs |