Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Job Template

jobTemplate.list

List all active and inactive job templates.

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

Requires the jobsRead permission.

post/jobTemplate.list

Request body

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 job templates to return per page. Maximum is 100.

syncTokenstring nullable

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

expandstring[] nullable

Expand the result with related objects. Supported values are location.

Example request

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

Response

Responses from the jobTemplate.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "title": "Software Engineer",
      "status": "Active",
      "locationId": "b9b9b9b9-b9b9-4b9b-b9b9-b9b9b9b9b9b9",
      "departmentId": "c8c8c8c8-c8c8-4c8c-c8c8-c8c8c8c8c8c8",
      "defaultInterviewPlanId": "d7d7d7d7-d7d7-4d7d-d7d7-d7d7d7d7d7d7",
      "interviewPlanIds": [
        "d7d7d7d7-d7d7-4d7d-d7d7-d7d7d7d7d7d7"
      ],
      "createdAt": "2022-08-12T20:29:56.964Z",
      "updatedAt": "2023-09-13T21:30:57.965Z"
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}