Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Applicants

Index

Methods

  • Get an applicant by applicant ID

    Parameters

    • id: number

      Identifier of the applicant

    Returns Promise<ApplicantDetail>

    • 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<Applicant[]>

    • Response with applicants list in the response body

Generated using TypeDoc