Deployments.ai Docs
Runtime

List approval requests

GET /v1/approvals · SDK listApprovals · CLI deployments approval list

GET
/v1/approvals

Requires approvals:read.

Authorization

headerAuthorizationBearer <token>

Opaque bearer credential scoped to one service account and tenant.

Query Parameters

cursor?string

Opaque cursor returned by the previous page.

Length1 <= length <= 4096
limit?integer

Maximum number of resources to return.

Range1 <= value <= 100
status?string

Only return approvals in this status.

Value in"approved""expired""pending""rejected"

Header Parameters

x-deployments-environment?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-organization?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-project?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

ListApprovalsResponse

application/json
  1. response
approvals*array<>
nextCursor?|null
curl -X GET "https://example.com/v1/approvals"
{  "approvals": [    {      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "version": 0,      "environmentId": "string",      "organizationId": "string",      "projectId": "string",      "escalatedAt": "2019-08-24T14:15:22Z",      "escalationCount": 0,      "escalationPolicy": {        "property1": null,        "property2": null      },      "executionBindingId": "string",      "executionPurpose": "customer",      "expiresAt": "2019-08-24T14:15:22Z",      "id": "string",      "object": "approval",      "request": {        "property1": null,        "property2": null      },      "requestedByAgentDeploymentId": "string",      "resolvedAt": "2019-08-24T14:15:22Z",      "resolvedByPrincipalId": "string",      "runId": "string",      "status": "approved",      "toolCallId": "string"    }  ],  "nextCursor": "string"}