Retrieve a list of ATS applications

Retrieves a list of applications in the Applicant Tracking System Token scopes: ats:read

Authentication

AuthorizationBearer
## Authentication Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. ``` curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` ### Generating Access Tokens 1. Navigate to **Apps & Perks > Developer Center**. 2. Click on the “Generate New Token” button. 3. In the popup, click “Generate Token” button to generate a new token. Your newly generated token is visible on the screen. 4. Make sure to copy and save your token once is generated. You won't be able to see it again!
OR
AuthorizationBearer
Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Query parameters

cursorstringOptional<=1000 characters
Cursor for pagination. Use the nextCursor value from the previous response to get the next page of results.
limitintegerOptional1-100Defaults to 20
Maximum number of applications to return per page
search_textstringOptional<=500 characters
Search text to filter applications by candidate name or email
job_idstringOptionalformat: "uuid"
Filter applications by specific job ID
interview_plan_stage_idslist of stringsOptional
Filter applications by specific interview plan stage IDs
candidate_tag_idslist of stringsOptional
Filter applications by candidate tag IDs
source_slugslist of stringsOptional
Filter applications by source slugs
job_criterias_matchingslist of objectsOptional
Filter applications by job criteria matching state. Each object specifies a job criteria ID and whether the candidate matches it.
current_stage_category_type_slugslist of stringsOptional
Filter applications by current stage category type slugs
current_stage_default_type_slugslist of stringsOptional
Filter applications by current stage default type slugs. Use 'others' for custom stages.
updated_afterstringOptionalformat: "date-time"

Filter applications updated after this timestamp (ISO 8601 format)

sort_byenumOptional
Field to sort applications by
Allowed values:
sort_orderenumOptional
Sort order for applications
Allowed values:

Response

Successfully retrieved applications
datalist of objects
has_moreboolean
Indicates if there are more applications to fetch
next_cursorstring or null
Cursor for the next page of results
total_countinteger
Total number of applications available

Errors