Theme switcher

Applicants

Header Parameters

Content-Typestring
Authorizationstring

Query Parameters

createdBystring

Filters applicants by user ID. These IDs can be retrieved from the getUsersList endpoint.

sourceinteger

Filters applicants by source ID. Source IDs can be retrieved from the getSourcesList endpoint.

sortOrderstring

Specifies the field used to sort results; accepts only supported fields per endpoint and defaults to a predefined field if not provided (e.g., sortBy=id&sortOrder=asc). Supports sorting by id, created_at, modify_date; defaults to descending order on id.

sortBystring

Determines the sorting direction, where desc applies descending order and asc applies ascending order; defaults to descending if not specified (e.g., sortBy=id&sortOrder=asc).

modifiedBeforestring

Filters applicants based on the date they were last modified. Only applicants that were modified before the specified date and time will be returned Example: modifiedBefore=2025-06-10 00:00:00

When both modifiedAfter and modifiedBefore are used, the API will return applicants that were modified within the specified date range.

Example: modifiedBefore=2025-06-10 00:00:00&modifiedAfter=2025-05-08 00:00:00

modifiedAfterstring

Filters applicants based on the date they were last modified. Only applicants that were modified after the specified date and time will be returnedExample: modifiedAfter=2025-06-10 00:00:00

When both modifiedAfter and modifiedBefore are used, the API will return applicants that were modified within the specified date range.

Example: modifiedBefore=2025-06-10 00:00:00&modifiedAfter=2025-05-08 00:00:00

limitinteger

Number of applicants to return per page. Must be between 5 and 50

applicantIdstring

Filters applicants by applicant ID

workAuthorizationstring

Filters applicants by work authorization status

emailstring

Filters applicants by email address (exact match)

skillsstring

Filters applicants by skills. Accepts comma-separated skill names. Performs case-insensitive partial match

modifiedBystring

Filters applicants by user ID. These IDs can be retrieved from the getUsersList endpoint.

createdAgoDaysinteger

Filters applicants created within the last N days. Common values: 1 (today), 2 (yesterday), 3 (last 3 days), 7 (last week), 14 (last 2 weeks), 30 (last month)

mobileNumberstring

Filters applicants by mobile number (exact match)

Response

200
Object

Response Attributes

idstring
applicant_idstring
firstnamestring
lastnamestring
middlenamestring
consultant_namestring
emailstring
email_address_1string
other_phonestring
addressstring
citystring
statestring
countrystring
mobile_numberstring
created_atstring
created_bystring
applicant_statusstring
skillsstring
sourcestring
resume_pathstring
home_phone_numberstring
work_phone_numberstring
job_titlestring
401
Object
{ "message": "Please provide the access token." }
403
Object
{ "message": "Your company access is temporarily disabled." }
404
Object
{ "message": "Data not found." }
429
Object
{ "message": "Request limit exceeded. Please try again later." }
400
Object
{ "message": "Invalid parameters or filters." }
Was this section helpful?

What made this section helpful for you?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section helpful for you?

What made this section unhelpful for you?