---
title: "List a job posting's applicants"
method: POST
path: "/v1/actions/list_job_applicants"
tags: ["Jobs"]
---

# List a job posting's 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

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

## Request body

- object
  - `jobId` string, required: The job posting id (from list_job_postings).
  - `service` 'CLASSIC' | 'RECRUITER': Which LinkedIn product the job posting belongs to (default CLASSIC).
  - `keywords` string: Only applicants matching these words.
  - `ratings` string[]: CLASSIC only: only these ratings.
  - `sortBy` 'relevance' | 'alphabetical' | 'newest_first' | 'screening_requirements': RECRUITER only.
  - `includeArchived` boolean: RECRUITER only: include archived applicants.
  - `yearsOfExperience` object: RECRUITER only.
    - `min` number
    - `max` number
  - `yearsInCompany` object: RECRUITER only: years in current company.
    - `min` number
    - `max` number
  - `yearsInPosition` object: RECRUITER only: years in current position.
    - `min` number
    - `max` number
  - `includeDegree` string[]: RECRUITER only: degree ids to include (lookup_search_ids type DEGREE).
  - `excludeDegree` string[]: RECRUITER only: degree ids to exclude.
  - `limit` number: How many to return (1–100, default 25).
  - `cursor` string: nextCursor from the previous call, to get the next page. Keep the other arguments the same.
  - `connectionId` string: Which of your LinkedIn accounts to act from (its id from list_linkedin_accounts). Omit to use your first live one.

## Response `200`

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.

- Worked
  - `ok` true, required
  - `result` object, required: What was asked for. A field that does not apply is left out, or is null.

## Other responses

- `default`: It did not work. The message says why, in plain English.

---

[API](https://skmtc.dev/heyreagent/apis/heyreagent-api.md) · [All operations](https://skmtc.dev/heyreagent/apis/heyreagent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/heyreagent/apis/heyreagent-api/revisions/917360c5f841?raw)
