Jobs

List a job posting's applicants

List who applied to one of your job postings.

The degree filters work on Recruiter postings only. That their ids come from lookup_search_ids type DEGREE is this tool's own wording; the published definition does not name the source.

An applicant's profileId is not documented as any kind of id; use publicProfileUrl to reach the person.

Docs: https://heyreagent.com/docs/actions/list_job_applicants

post/v1/actions/list_job_applicants

Request

  • Base URL: https://api.heyreagent.com
  • URL: https://api.heyreagent.com/v1/actions/list_job_applicants
  • Auth: HTTP bearer

Request body

jobIdstring required

The job posting id (from list_job_postings).

service'CLASSIC' | 'RECRUITER'

Which LinkedIn product the job posting belongs to (default CLASSIC).

keywordsstring

Only applicants matching these words.

ratingsstring[]

CLASSIC only: only these ratings.

sortBy'relevance' | 'alphabetical' | 'newest_first' | 'screening_requirements'

RECRUITER only.

includeArchivedboolean

RECRUITER only: include archived applicants.

includeDegreestring[]

RECRUITER only: degree ids to include (lookup_search_ids type DEGREE).

excludeDegreestring[]

RECRUITER only: degree ids to exclude.

limitnumber

How many to return (1–100, default 25).

cursorstring

nextCursor from the previous call, to get the next page. Keep the other arguments the same.

connectionIdstring

Which of your LinkedIn accounts to act from (its id from list_linkedin_accounts). Omit to use your first live one.

Response

It worked. Inside result: returned, nextCursor, applicants[].id, applicants[].profileId, applicants[].publicIdentifier, applicants[].publicProfileUrl, applicants[].name, applicants[].location, applicants[].headline, applicants[].profilePictureUrl, applicants[].appliedAt, applicants[].rating, applicants[].hiringState, applicants[].emailAddress, applicants[].phoneNumber.

oktrue required
resultobject required

What was asked for. A field that does not apply is left out, or is null.

Changes

No recorded changes to this operation across all 1 revision of this API.