Applicants
List all applicants
const applicants = await ft.applicants.list(jobPostingId, query);
- Returns a
Response
object that resolves to an Array
of Freshteam.models.ApplicantDetail
objects - The second argument provides queries accepted by the REST API. (TODO: Document the query parameters)
Get applicant by ID
const applicant = await ft.applicants.get(id);
- Returns a
Response
object that resolves to a Freshteam.models.ApplicantDetail
object
Update an applicant
const applicant = await ft.applicants.update(id, applicant);
- Returns a
Response
object that resolves to a Freshteam.models.ApplicantDetail
object - The second argument is of type
Freshteam.models.ApplicantUpdate
Archive an applicant
const applicant = await ft.applicants.archive(id, options);
- Returns a
Response
object that resolves to a Freshteam.models.ApplicantDetail
object - The second argument is of type
Freshteam.models.ApplicantArchive
Update applicant sub-stage
const applicant = await ft.applicants.updateSubStage(id, options);
- Returns a
Response
object that resolves to a Freshteam.models.ApplicantDetail
object - The second argument is of type
Freshteam.models.ApplicantSubStage