Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Openings

opening.list

Lists openings.

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

Requires the jobsRead permission.

post/opening.list

Request body

createdAfterinteger nullable

The API will return data after this date, which is the time since the unix epoch in milliseconds

cursorstring nullable

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

syncTokenstring nullable

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

limitinteger nullable

The maximum number of openings to return per page.

Example request

{
  "cursor": "G8",
  "syncToken": "jYnEBmjzR",
  "limit": 25
}

Response

Responses from the opening.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "595ae947-e308-4a36-af06-70b7f6e0fb82",
      "openedAt": null,
      "closedAt": null,
      "isArchived": false,
      "closeReasonId": null,
      "archivedAt": null,
      "openingState": "Approved",
      "latestVersion": {
        "id": "3f60be56-95d3-4e5f-a54a-cccfc8056dc2",
        "identifier": "119471",
        "description": "119471",
        "authorId": "eefc52e9-f227-4844-a8a4-9fbfb4a90e5d",
        "createdAt": "2026-04-23T20:32:13.800Z",
        "targetHireDate": null,
        "targetStartDate": null,
        "isBackfill": false,
        "employmentType": "FullTime",
        "teamId": null,
        "jobIds": [],
        "locationIds": [
          "6f5c032e-c14e-4197-94f2-e3218cff8478"
        ],
        "hiringTeam": [],
        "customFields": []
      }
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}