Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Applicants

Index

Methods

  • archive(id: any, options: Applicant): Promise<any>
  • Archive an applicant

    Parameters

    • id: any

      Identifier of the applicant

    • options: Applicant

      Properties to filter the applicant

    Returns Promise<any>

    • Response with applicant fields list in the response body
  • get(id: number): Promise<any>
  • Get an applicant by applicant ID

    Parameters

    • id: number

      Identifier of the applicant

    Returns Promise<any>

    • Response with applicant object in the response body
  • Fetches list of applicants

    const FT = new Freshteam(domain, apiKey);
    await FT.applicants.list(jobPostingId, query);

    Parameters

    • jobPostingId: number

      ID of the job posting to search applicants for

    • query: ApplicantListQuery

      Options to filter applicants

    Returns Promise<any>

    • Response with applicants list in the response body
  • Update an existing applicant

    Parameters

    • id: number

      Identifier of the applicant

    • applicant: ApplicantUpdate

      Properties for the applicant

    Returns Promise<any>

    • Response with applicant object in the response body
  • Update sub-stage of an applicant

    Parameters

    • id: number

      Identifier of the applicant

    • options: ApplicantSubStage

      Properties to update sub stage

    Returns Promise<any>

    • Response with applicant fields list in the response body

Generated using TypeDoc