List Approvals

curl --request GET \
  --url https://api.example.com/approvals \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "run_id": "<string>",
      "session_id": "<string>",
      "status": "<string>",
      "source_type": "<string>",
      "approval_type": "<string>",
      "pause_type": "<string>",
      "tool_name": "<string>",
      "tool_args": {},
      "expires_at": 123,
      "agent_id": "<string>",
      "team_id": "<string>",
      "workflow_id": "<string>",
      "user_id": "<string>",
      "schedule_id": "<string>",
      "schedule_run_id": "<string>",
      "source_name": "<string>",
      "requirements": [
        {}
      ],
      "context": {},
      "resolution_data": {},
      "resolved_by": "<string>",
      "resolved_at": 123,
      "created_at": 123,
      "updated_at": 123
    }
  ],
  "meta": {
    "page": 0,
    "limit": 20,
    "total_pages": 0,
    "total_count": 0,
    "search_time_ms": 0
  }
}

GET

approvals

List Approvals

curl --request GET \
  --url https://api.example.com/approvals \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "run_id": "<string>",
      "session_id": "<string>",
      "status": "<string>",
      "source_type": "<string>",
      "approval_type": "<string>",
      "pause_type": "<string>",
      "tool_name": "<string>",
      "tool_args": {},
      "expires_at": 123,
      "agent_id": "<string>",
      "team_id": "<string>",
      "workflow_id": "<string>",
      "user_id": "<string>",
      "schedule_id": "<string>",
      "schedule_run_id": "<string>",
      "source_name": "<string>",
      "requirements": [
        {}
      ],
      "context": {},
      "resolution_data": {},
      "resolved_by": "<string>",
      "resolved_at": 123,
      "created_at": 123,
      "updated_at": 123
    }
  ],
  "meta": {
    "page": 0,
    "limit": 20,
    "total_pages": 0,
    "total_count": 0,
    "search_time_ms": 0
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status

enum<string> | null

Available options:

pending,

approved,

rejected,

expired,

cancelled

source_type

string | null

approval_type

enum<string> | null

Available options:

required,

audit

pause_type

string | null

agent_id

string | null

team_id

string | null

workflow_id

string | null

user_id

string | null

schedule_id

string | null

run_id

string | null

limit

integer

default:100

Required range: 1 <= x <= 1000

page

integer

default:1

Required range: x >= 1

Response

Successful Response

data

ApprovalResponse · object[]

required

List of items for the current page

Show child attributes