Endpoints to submit, update, and manage candidate information including resumes and profiles.
Retrieve all candidates
Fetch a list of all candidates in the system. You can use optional query parameters to filter candidates based on specific criteria, such as location, source, or status.
query Parameters
pageinteger · requiredPage number
sizeinteger · requiredNumber of items per page
source_idstringsource id of the candidate
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Successful operation
idstringThe unique identifier for the candidate.
first_namestringThe candidate's first name.
last_namestringThe candidate's last name.
emailstringThe candidate's email address used for communication.
phone_nostringThe candidate's phone number, used for contact. Example: '+919803879562'.
citystringThe candidate's current city of residence.
state_namestringThe state where the candidate resides, for example, 'TX'.
countrystringThe country where the candidate resides.
sourcestringThe source from which the candidate applied, such as 'LinkedIn' or 'Referral'.
source_idstringA unique identifier for the source from where the candidate applied.
recruiter_namestringThe name of the recruiter assigned to the candidate.
recruiter_emailstringThe recruiter's email for correspondence.
recruiter_work_phone_nostringThe recruiter's work phone number.
statusstringThe current status of the candidate within the recruitment process (e.g., 'Applied', 'Interviewing', 'Hired').
created_atstring · date-timeThe date and time when the candidate was added to the system.
updated_atstring · date-timeThe date and time when the candidate's information was last updated.
Add a new candidate
Create a new candidate entry in the system by providing details such as first name, last name, phone number, email, city, state, and the source from which the candidate applied (e.g., LinkedIn). This endpoint allows for the registration of new candidates, adding them to the recruitment pipeline.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
first_namestring · requiredThe candidate's first name.
emailstring · requiredThe candidate's email address used for communication.
phone_nostring · requiredThe candidate's phone number, used for contact. Example: '+919803879562'.
sourcestring · requiredThe source from which the candidate applied, such as 'LinkedIn' or 'Referral'.
source_idstring · requiredA unique identifier for the source from where the candidate applied.
filestring · binarylast_namestringThe candidate's last name.
citystringThe candidate's current city of residence.
state_namestringThe state where the candidate resides, for example, 'Minnesota'.
countrystringThe country where the candidate resides.
Responses
Retrieve candidate details
Fetch detailed information about a specific candidate using their unique candidate ID. The response will include personal information such as the candidate's name, contact details, city, state, and the source of their application.
path Parameters
candidate_idstring · requiredID of the candidate to retrieve
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Successful operation
idstringThe unique identifier for the candidate.
first_namestringThe candidate's first name.
last_namestringThe candidate's last name.
emailstringThe candidate's email address used for communication.
phone_nostringThe candidate's phone number, used for contact. Example: '+919803879562'.
citystringThe candidate's current city of residence.
state_namestringThe state where the candidate resides, for example, 'TX'.
countrystringThe country where the candidate resides.
sourcestringThe source from which the candidate applied, such as 'LinkedIn' or 'Referral'.
source_idstringA unique identifier for the source from where the candidate applied.
recruiter_namestringThe name of the recruiter assigned to the candidate.
recruiter_emailstringThe recruiter's email for correspondence.
recruiter_work_phone_nostringThe recruiter's work phone number.
statusstringThe current status of the candidate within the recruitment process (e.g., 'Applied', 'Interviewing', 'Hired').
created_atstring · date-timeThe date and time when the candidate was added to the system.
updated_atstring · date-timeThe date and time when the candidate's information was last updated.
Update candidate details
Update the information of a specific candidate by providing their candidate ID. You can modify fields such as the candidate's name, phone number, email, city, state, or the source of their application. This endpoint is useful for keeping candidate information up to date.
path Parameters
candidate_idstring · requiredID of the candidate to retrieve
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
first_namestring · requiredThe candidate's first name.
emailstring · requiredThe candidate's email address used for communication.
phone_nostring · requiredThe candidate's phone number, used for contact. Example: '+919803879562'.
sourcestring · requiredThe source from which the candidate applied, such as 'LinkedIn' or 'Referral'.
source_idstring · requiredA unique identifier for the source from where the candidate applied.
last_namestringThe candidate's last name.
citystringThe candidate's current city of residence.
state_namestringThe state where the candidate resides, for example, 'Minnesota'.
countrystringThe country where the candidate resides.
Responses
Successful operation
idstringThe unique identifier for the candidate.
first_namestringThe candidate's first name.
last_namestringThe candidate's last name.
emailstringThe candidate's email address used for communication.
phone_nostringThe candidate's phone number, used for contact. Example: '+919803879562'.
citystringThe candidate's current city of residence.
state_namestringThe state where the candidate resides, for example, 'TX'.
countrystringThe country where the candidate resides.
sourcestringThe source from which the candidate applied, such as 'LinkedIn' or 'Referral'.
source_idstringA unique identifier for the source from where the candidate applied.
created_atstring · date-timeThe date and time when the candidate was added to the system.
updated_atstring · date-timeThe date and time when the candidate's information was last updated.