Runs

Last updated 1 year ago

Was this helpful?

List approval flow runs

get

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

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

approvalIdstring · uuidrequired

Query parameters

pageTokenstring

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

limitinteger · min: 1 · max: 100 · default: 10

Limits the number of results to return

reverseboolean

Order in which to retrieve the results

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/organizations/{organizationId}/approvals/{approvalId}/runs' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "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",
      "activeStep": 1,
      "previousObject": {},
      "object": {},
      "createdAt": "2025-02-21T18:11:20.348Z",
      "updatedAt": "2025-02-21T18:11:20.348Z",
      "status": "pending",
      "tags": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "results": [
        {
          "reviewer": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "type": "user"
          },
          "userId": "123e4567-e89b-12d3-a456-426614174000",
          "comment": "text",
          "result": "approved"
        }
      ]
    }
  ],
  "nextPageToken": "text"
}

Get approval flow run

get

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