Skip to navigation

Retrieve a list of ATS jobs

Lists the jobs of the organization together with every stage of their interview plans. Use it to find a job, or to look up a stage id before filtering applications or interviews by stage, since stage names are customer-defined.

Token scopes: ats:read, worker:read

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.deel.training/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

OR
AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Query parameters

cursorstringOptional
The cursor for pagination
limitintegerOptional1-100Defaults to 20
Maximum number of records returned in one response
searchstringOptional

Text to search for in job records (optional)

job_idslist of stringsOptional

Array of job UUIDs (optional). Returns only these jobs, so a caller holding job ids from another endpoint can resolve them in one request instead of paging the whole list. Omitting it leaves the result set unchanged.

interview_plan_idstringOptionalformat: "uuid"

Interview plan UUID (optional)

location_idslist of stringsOptional

Array of location UUIDs (optional)

team_idslist of stringsOptional

Array of team UUIDs (optional)

employment_type_idslist of stringsOptional

Array of employment type UUIDs (optional)

department_idslist of stringsOptional

Array of department UUIDs (optional)

updated_afterstringOptionalformat: "date-time"

Filter jobs updated after this timestamp (ISO 8601 format)

statuslist of enumsOptional

Array of job status values (optional)

opened_afterstringOptionalformat: "date-time"

Return jobs first opened at or after this timestamp (ISO 8601). Jobs that were never opened are excluded.

opened_beforestringOptionalformat: "date-time"

Return jobs first opened at or before this timestamp (ISO 8601). Jobs that were never opened are excluded.

closed_afterstringOptionalformat: "date-time"

Return jobs closed at or after this timestamp (ISO 8601). Jobs that were never closed are excluded.

closed_beforestringOptionalformat: "date-time"

Return jobs closed at or before this timestamp (ISO 8601). Jobs that were never closed are excluded.

hiring_member_hou_idslist of stringsOptional

Return only jobs on whose hiring team at least one of these HRIS organization users sits. Only narrows the jobs the caller can already see. Callers without ATS admin rights only ever see themselves in hiring_members, even when filtering by someone else.

work_arrangementslist of enumsOptional

Array of work arrangement values to filter by (optional)

Allowed values:

Response

Successful operation.
datalist of objects
Page of jobs.
has_moreboolean
Whether more pages are available.
next_cursorstring or null

Cursor to fetch the next page; null when there are no more pages.

total_countinteger
Total number of jobs matching filters.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error