Get Approval

GET /approvals/{approval_id}

Get Approval

cURL

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

200

{
  "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,
  "run_status": "PENDING"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

approval_id · string · required

Response

200

application/json

Successful Response

Response model for a single approval.

id · string · required

run_id · string · required

session_id · string · required

status · string · required

source_type · string · required

approval_type · string | null

pause_type · string | null

tool_name · string | null

tool_args · Tool Args · object

expires_at · integer | null

agent_id · string | null

team_id · string | null

workflow_id · string | null

user_id · string | null

schedule_id · string | null

schedule_run_id · string | null

source_name · string | null

requirements · Requirements · object[] | null

context · Context · object

resolution_data · Resolution Data · object

resolved_by · string | null

resolved_at · integer | null

created_at · integer | null

updated_at · integer | null

run_status · enum<string> | null

State of the main run response

Available options: PENDING, RUNNING, COMPLETED, PAUSED, CANCELLED, ERROR