Runs

List approval flow runs

get

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

organizationIdstringRequired

The organization ID

approvalIdstring · uuidRequired

Query parameters

pageTokenstringOptional

Pagination token that keeps of track of the current position in the list

limitinteger · min: 1 · max: 100Optional

Limits the number of results to return

Default: 10

reversebooleanOptional

Order in which to retrieve the results

Default: false

Responses

200

OK

application/json

404

Resource not found

application/json

get

/organizations/{organizationId}/approvals/{approvalId}/runs

HTTPcURLJavaScriptPython

GET /organizations/{organizationId}/approvals/{approvalId}/runs HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "approvalFlowId": "123e4567-e89b-12d3-a456-426614174000",
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
      "status": "pending",
      "activeStep": 1,
      "previousObject": {},
      "object": {},
      "invoker": {
        "type": "user",
        "id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "tags": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "results": [
        {
          "reviewer": {
            "type": "user",
            "id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "result": "approved",
          "comment": "text"
        }
      ],
      "createdAt": "2025-12-16T21:56:59.422Z",
      "updatedAt": "2025-12-16T21:56:59.422Z"
    }
  ],
  "nextPageToken": "text"
}

Get approval flow run

get

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

organizationIdstringRequired

The organization ID

approvalIdstring · uuidRequired

approvalRunIdstring · uuidRequired

Responses

200

OK

application/json

404

Resource not found

application/json

get

/organizations/{organizationId}/approvals/{approvalId}/runs/{approvalRunId}

HTTPcURLJavaScriptPython

GET /organizations/{organizationId}/approvals/{approvalId}/runs/{approvalRunId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "approvalFlowId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "pending",
  "activeStep": 1,
  "previousObject": {},
  "object": {},
  "invoker": {
    "type": "user",
    "id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "results": [
    {
      "reviewer": {
        "type": "user",
        "id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "result": "approved",
      "comment": "text"
    }
  ],
  "createdAt": "2025-12-16T21:56:59.422Z",
  "updatedAt": "2025-12-16T21:56:59.422Z"
}