Endpoints to handle the creation and management of job applications, allowing you to track candidate submissions for specific job postings.
Retrieve all applications
Fetch a list of all job applications in the system. You can use optional query parameters to filter applications by candidate, job, or status. This is useful for tracking and managing the progress of applications across various job postings.
query Parameters
pageinteger · requiredPage number
sizeinteger · requiredNumber of items per page
job_iduuidjob uuid
source_idstringsource id of the application
job_source_idstringsource id of the job
candidate_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
dataobject[]A list of applications retrieved.
countintegerTotal number of applications retrieved.
Submit a new application
Create a new application for a job by providing the candidate ID, job ID, and the source of the application. This endpoint records the application in the system and links it to both the candidate and the job.
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
candidate_source_idstring · requiredSource ID of the candidate
job_source_idstring · requiredSource ID of the job
source_application_statusstring · requiredStatus of the application in the source system
application_stagestring · requiredCurrent stage of the application. ACTIVE/PASSIVE
filestring · binaryResume file to upload
base64filestringBase64 encoded resume file. Use this instead of 'file' when uploading via base64
candidate_idstring · uuidID of the candidate
job_idstring · uuidID of the job
Responses
Application created successfully
idstringcandidate_source_idstringjob_source_idstringcandidate_idstringjob_idstringsource_application_statusstringapplication_stagestringstorage_resumestringPath to the stored resume file
Retrieve a specific application
Fetch detailed information about a specific application using its unique application ID. The response includes the candidate details, job details, and the current status of the application.
path Parameters
application_idstring · requiredID of the application 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
idstring · uuidUnique identifier for the application.
candidate_idstring · uuidUnique identifier for the candidate associated with the application.
screening_statusstringThe result of the screening process for the candidate (e.g., 'failed', 'passed').
source_application_statusstringStatus of the application as reported by the source system (e.g., 'added', 'in-progress').
application_stagestringStage of the application (e.g., 'active', 'passive').
created_atstring · date-timeTimestamp of when the application was created.
updated_atstring · date-timeTimestamp of when the application was last updated.
candidatesobjectDetails of the candidate associated with the application.
jobsobjectDetails of the job associated with the application.
Update a specific application
Update the details of an existing application using its application ID. You can modify the application's status or other associated details, such as the candidate's progress in the recruitment process.
path Parameters
application_idstring · requiredID of the application 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
source_application_statusstring · requiredhired
application_stagestring · requiredactive
filestring · binary
Responses
Successful operation
idstringcandidate_source_idstringjob_source_idstringcandidate_idstringjob_idstringsource_application_statusstringapplication_stagestring
Create a new application with questions
Create a new application for a job and associate questions with it. This endpoint allows you to submit an application along with a set of questions that will be used during the screening process.
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
candidate_source_idstring · requiredSource ID of the candidate
job_source_idstring · requiredSource ID of the job
source_application_statusstring · requiredStatus of the application in the source system
application_stagestring · requiredCurrent stage of the application. ACTIVE/PASSIVE
filestring · binaryResume file to upload
base64filestringBase64 encoded resume file. Use this instead of 'file' when uploading via base64
candidate_idstring · uuidID of the candidate
job_idstring · uuidID of the job
questionsobject[]Array of questions to associate with the application
Responses
Application created successfully with questions
idstringcandidate_source_idstringjob_source_idstringcandidate_idstringjob_idstringsource_application_statusstringapplication_stagestringquestionsobject[]