List applicants
Get all applicants for a specific job or organization.Parameters
The job ID to get applicants for
Response
Indicates if an error occurred
Array of applicant objects ordered by creation date (oldest first)
Error message if job not found or internal error
Get applicant details
Retrieve detailed information about a specific applicant, including resume URL.Parameters
The applicant’s unique ID
Response
Indicates if an error occurred
The applicant object (null if not found)
Pre-signed URL to download/view the applicant’s resume (expires after a set time)
Update applicant status
Update an applicant’s application status.Parameters
The applicant ID
New status to setOptions:
SUBMITTED, UNDERREVIEW, INTERVIEW, OFFER, REJECTED, HIREDResponse
Indicates if the update was successful
The updated applicant object
Error handling
The endpoint will throw an error if:- User is not authenticated (“Unauthenticated”)
- Applicant is not found (“Applicant not found”)
- User doesn’t have access to the organization (“Access denied”)
- Update fails (“Failed to update applicant status”)
Move applicant to pipeline stage
Move an applicant to a different stage in the hiring pipeline.Parameters
The applicant ID
The target pipeline stage ID
Response
Returns the updated applicant object with the new stage information.Applicant ID
Updated stage ID
Full stage object with name and order
Activity logging
When an applicant is moved to a new stage, an activity log entry is automatically created with:- Action: “MOVED_STAGE”
- Metadata containing the previous stage name and new stage name
- Actor ID (the user who performed the action)
- Timestamp
Get applicant history
Retrieve complete history and activity for an applicant.Parameters
The applicant ID
Response
Returns the applicant object with related data:All activity logs ordered by creation date (newest first)
Communication history (emails, notes, calls) ordered by date
Interview evaluations ordered by date
Applicant status values
SUBMITTED- Application received, awaiting reviewUNDERREVIEW- Application is being reviewedINTERVIEW- Candidate is in interview stageOFFER- Offer has been extendedREJECTED- Application rejectedHIRED- Candidate has been hired