Sign in

v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Applicant Tracking
Public API

Get Job Applications

Get a list of applications. The authenticated caller must have access to ATS settings. Combine as many different optional parameter filters as you like.

OAuth Scopes: hiring:applications

get/api/v1/applicant_tracking/applications

Query parameters

pageinteger

The page number

jobIdinteger

A Job Id to limit results to

applicationStatusIdstring

One or more application status IDs to filter by, comma-separated (e.g. 1,2,3).

applicationStatusstring

One or more application status group codes to filter by, comma-separated (e.g. NEW,ACTIVE). Allowed values: ALL, ALL_ACTIVE, NEW, ACTIVE, INACTIVE, HIRED.

jobStatusGroupsstring

One or more position status groups to filter by, comma-separated (e.g. Draft,Open). Allowed values: ALL, DRAFT_AND_OPEN, Open, Filled, Draft, Deleted, On Hold, Canceled.

searchStringstring

A general search criteria by which to find applications.

sortBy'first_name' | 'job_title' | 'rating' | 'phone' | 'status' | 'last_updated' | 'created_date'

A specific field to sort the results by.

sortOrder'ASC' | 'DESC'

Order by which to sort results.

newSincestring
Example:2024-01-01 13:00:00

Only return applications submitted after this UTC timestamp. Format: Y-m-d H:i:s (e.g. 2024-01-01 13:00:00). Do NOT use ISO 8601 format (no T separator or Z suffix).

Response

Success. Returns a paginated list of applications.

paginationCompleteboolean

Indicates whether there are more pages of results available

nextPageUrlstring nullable

URL to fetch the next page of results, or null if there are no more results