Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Approval

approval.list

Gets all approvals in the organization. You can optionally filter by entity type and entity ID.

See the Pagination and Incremental Synchronization guide for detailed usage examples.

Requires the approvalsRead permission.

post/approval.list

Request body

entityType'offer' | 'job' | 'opening' nullable

Filter approvals by the type of entity they are associated with

entityIdstring uuid nullable

Filter approvals to only those associated with this specific entity ID

cursorstring nullable

The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.

limitinteger nullable

The maximum number of approvals to return per page. Maximum is 100.

syncTokenstring nullable

A sync token to retrieve only approvals updated since the last sync. Obtained from a previous list response.

Example request

{
  "entityId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "cursor": "G8",
  "limit": 25,
  "syncToken": "jYnEBmjzR"
}

Response

Responses from the approval.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "approvalDefinitionId": "8af2ed38-6fd1-476b-9e95-3b57f6a0ee8f",
      "entityId": "32665f7b-8d4c-4c58-9f28-62c5a4d20d57",
      "entityType": "Offer",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "submittedAt": "2024-01-15T10:35:00.000Z",
      "completedAt": null,
      "steps": [
        {
          "id": "181c9a75-1646-4232-b312-e9a95b82af41",
          "approvalsRequired": 1,
          "completedAt": null,
          "approvers": [
            {
              "id": "f3268949-c6f2-4fb8-b85b-69806729fbb8",
              "userId": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
              "decision": "pending",
              "decidedAt": null,
              "requestedAt": "2024-01-15T10:35:00.000Z"
            }
          ]
        }
      ]
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}