Skip to navigation
EndpointsAts

Retrieve the ATS activity timeline

Beta

Returns the history of changes made to a candidate, application or job — who changed what and when, newest first. Use it to investigate how a record reached its current state, for example who approved an offer.

Token scopes: ats:read, worker:read

Beta: this version requires the X-Beta: true request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-28.

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.letsdeel.com/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/

Headers

X-BetaenumRequiredDefaults to true

Opts in to the beta version of this endpoint. Must be true.

Allowed values:

Query parameters

cursorstringOptional<=1000 characters
Pagination cursor returned by a previous response.
limitintegerOptional1-100Defaults to 30
Maximum number of entries to return per page.
candidate_idslist of stringsOptional

Only entries about these candidates, across all of their applications. Combined with application_ids, returns the candidate’s own entries plus those of the listed applications.

application_idslist of stringsOptional
Only entries about these applications.
job_idslist of stringsOptional
Only entries about these jobs and their applications.
categorieslist of enumsOptional
Only entries about these kinds of record.
created_by_hris_organization_user_idslist of stringsOptional
Only entries for changes made by these HRIS organization users.
date_range_startstringOptionalformat: "date-time"

Only entries created at or after this timestamp (ISO 8601).

date_range_endstringOptionalformat: "date-time"

Only entries created at or before this timestamp (ISO 8601).

Response

Page of activity entries
datalist of objects
Page of activity entries, newest first.
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 entries matching the filters.

Errors

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