Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Job

job.list

Lists all jobs.

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

Requires the jobsRead permission.

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

syncTokenstring nullable

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

statusstring[] nullable

When supplied, only jobs with the provided status(es) are returned. Accepted values are Draft, Open, Closed, and Archived (case-insensitive).

createdAfterinteger nullable

Return jobs created at or after this date. Unix timestamp in milliseconds.

openedAfterinteger nullable

Return jobs opened after this date. Unix timestamp in milliseconds.

openedBeforeinteger nullable

Return jobs opened before this date. Unix timestamp in milliseconds.

closedAfterinteger nullable

Return jobs closed after this date. Unix timestamp in milliseconds.

closedBeforeinteger nullable

Return jobs closed before this date. Unix timestamp in milliseconds.

includeUnpublishedJobPostingsIdsboolean nullable

Whether to include unpublished job posting ids in the response

expandstring[] nullable

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

Example request

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

Response

Responses from the job.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "1be42b8e-cafd-4beb-8121-f4981eb20f42",
      "title": "Software Engineer",
      "confidential": false,
      "status": "Open",
      "employmentType": "FullTime",
      "locationId": "3ae2b801-19f6-41ef-ad28-214bd731948f",
      "departmentId": "f9e52a51-a075-4116-a7b8-484deba69004",
      "defaultInterviewPlanId": "595ae947-e308-4a36-af06-70b7f6e0fb82",
      "interviewPlanIds": [
        "595ae947-e308-4a36-af06-70b7f6e0fb82"
      ],
      "jobPostingIds": [],
      "customRequisitionId": "ENG-01",
      "brandId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "hiringTeam": [],
      "customFields": [],
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "openedAt": "2024-01-02T00:00:00.000Z",
      "closedAt": null
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}