v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Close Reason

closeReason.list

Lists all close reasons for jobs or openings.

Requires the hiringProcessMetadataRead permission.

post/closeReason.list

Request body

includeArchivedboolean nullable

Whether to include archived close reasons in the response.

Response

Responses from the closeReason.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "8d1f3b6c-6f31-4d29-9c1f-1f4c5b4d8f4a",
      "reasonText": "Position Filled",
      "isArchived": false
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}