Skip to navigation

List interview plan stages of a job with pipeline counts

Returns the interview plan of a job in pipeline order, with how many applications are in each stage now and how many have ever reached it. Use it to read a pipeline snapshot of the job or to find a stage before filtering GET /rest/ats/applications or GET /rest/ats/interviews by it. Counts cover only the applications the caller may see.

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

Path parameters

job_idstringRequiredformat: "uuid"
Job whose interview plan stages to list.

Query parameters

includelist of enumsOptional

Optional expansions. CURRENT_APPLICATIONS embeds the most recently moved applications currently sitting in each stage.

Allowed values:
applications_per_stage_limitintegerOptional1-25Defaults to 10

Maximum number of current applications embedded per stage when include=CURRENT_APPLICATIONS (1-25).

Response

Interview plan stages with pipeline counts.
datalist of objects
Stages of the job's interview plan, in pipeline order.
has_moreboolean

Always false; the list is not paginated.

next_cursorstring or null

Always null; the list is not paginated.

total_countinteger
Number of stages.

Errors

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