Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Application

application.listHistory

Fetch a paginated list of application history items for an application.

This endpoint supports pagination only (not incremental sync). See the Pagination and Incremental Synchronization guide for usage examples.

Requires the candidatesRead permission.

post/application.listHistory

Request body

applicationIdstring uuid required

The id of the application to fetch.

cursorstring nullable

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

limitnumber nullable

The maximum number of history events to return per page.

Example request

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

Response

Responses from the application.listHistory endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "0d7f1d4e-cdb1-4d72-9c1d-9b1d4d72e0bd",
      "stageId": "c153b3e9-8b97-4fc0-bad1-6c654122c1f8",
      "title": "Application Review",
      "enteredStageAt": "2024-01-15T10:30:00.000Z",
      "leftStageAt": null,
      "stageNumber": 0,
      "allowedActions": [
        "delete",
        "set_entered_at"
      ],
      "actorId": null
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}