Skip to navigation
EndpointsAts

List the private note of a job

Beta

Reads the job’s private note, which the hiring team shares to keep context about the job. Read it before adding to the note, so the addition can be confirmed against its current content.

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-29.

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/

Path parameters

job_idstringRequiredformat: "uuid"
ID of the job

Headers

X-BetaenumRequiredDefaults to true

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

Allowed values:

Response

The private note of the job
datalist of objects
The private note of the job, or an empty list when the job has none. A job has at most one note.
has_moreboolean

Always false: a job has at most one note.

next_cursorstring or null

Always null: a job has at most one note.

total_countinteger

Number of notes on the job (0 or 1).

Errors

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