Methods
listEscalations()— list all escalations for your organizationlistEscalationsByPolicyId(policyId)— filter by policy IDapproveEscalation(escalationId)— approve an escalationdeclineEscalation(escalationId)— decline an escalation
listEscalations()
Returns all escalation records for your organization.
Signature
listEscalationsByPolicyId(policyId)
Returns escalations filtered by policy ID.
Signature
| Parameter | Type | Required | Description |
|---|---|---|---|
policyId | string | Yes | Policy ID to filter by. |
approveEscalation(escalationId)
Marks an escalation as approved.
Signature
| Parameter | Type | Required | Description |
|---|---|---|---|
escalationId | string | Yes | ID of the escalation. |
status: 'ALLOWED').
declineEscalation(escalationId)
Marks an escalation as declined.
Signature
| Parameter | Type | Required | Description |
|---|---|---|---|
escalationId | string | Yes | ID of the escalation. |
status: 'DECLINED').
Escalation object
Each item has a fixedresponse shape and a request-dependent request:
| Field | Type | Description |
|---|---|---|
id | string | Escalation ID. |
policy_id | string | Policy that triggered the escalation. |
organization_id | string | Your organization ID. |
status | string | PENDING, ALLOWED, or DECLINED. |
created_at | string | ISO 8601 timestamp. |
updated_at | string | ISO 8601 timestamp. |
request | any (optional) | Request payload (e.g. { transaction: { amount: 1200 } }). |
response | object (optional) | Policy result at time of escalation: action, message, success, violated. |
action_by | string | null (optional) | ID of user who approved/declined. |
Complete example
Error handling
Throws:InvalidInputError for invalid IDs; APIRequestError, NetworkError for API/network failures.
API summary
| Method | Description |
|---|---|
limits.listEscalations() | List all escalations. Returns Escalation[]. |
limits.listEscalationsByPolicyId(policyId) | List escalations by policy. Returns Escalation[]. |
limits.approveEscalation(escalationId) | Approve by ID. Returns Escalation. |
limits.declineEscalation(escalationId) | Decline by ID. Returns Escalation. |