Applicants
Header Parameters
Query Parameters
Filters applicants by user ID. These IDs can be retrieved from the getUsersList endpoint.
Filters applicants by source ID. Source IDs can be retrieved from the getSourcesList endpoint.
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.
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).
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
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
Number of applicants to return per page. Must be between 5 and 50
Filters applicants by applicant ID
Filters applicants by work authorization status
Filters applicants by email address (exact match)
Filters applicants by skills. Accepts comma-separated skill names. Performs case-insensitive partial match
Filters applicants by user ID. These IDs can be retrieved from the getUsersList endpoint.
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)
Filters applicants by mobile number (exact match)
Response
Response Attributes
{ "message": "Please provide the access token." }
{ "message": "Your company access is temporarily disabled." }
{ "message": "Data not found." }
{ "message": "Request limit exceeded. Please try again later." }
{ "message": "Invalid parameters or filters." }