rc.retrieveProjectCandidates
Read the candidates in the pipeline of a LinkedIn Recruiter Lite project, from all stages or from one stage, with the stage each candidate is in.
The account needs a Recruiter Lite seat, Linked API's Plus plan and a supported LinkedIn interface language – see Recruiter Lite. To find a project's ID, call rc.retrieveProjects.
In the SDK this is the rcRetrieveProjectCandidates method. It takes the parameters below except label, which exists only in workflow JSON, and returns the result below in data.
The command is linkedin recruiter projects candidates. Its argument and flags are listed below.
Constraints
⏺️ Root Start: allowed.
⬆️ Parent Actions: N/A.
⬇️ Child Actions: N/A.
Parameters
{
"actionType": "rc.retrieveProjectCandidates",
"label": "pipeline",
"projectId": "1700000001",
"stage": "uncontacted",
"limit": 100
}In AI assistants, the MCP tool is rc_retrieve_project_candidates. The n8n action is Retrieve project candidates in Recruiter Lite; the Make module is Retrieve Project Candidates in Recruiter Lite.
| Parameter | Description |
|---|---|
label | Optional. Label included in workflow completion. |
projectId | Required. Project ID, a string of digits, from rc.retrieveProjects or rc.createProject. |
stage | Optional. Read only this stage: uncontacted, contacted, replied or archived. Omit it to read all stages. |
limit | Optional. Number of candidates to return, from 1 to 1000. Defaults to 25. |
| Arg | Required | Description |
|---|---|---|
project-id | yes | Project ID, from linkedin recruiter projects or linkedin recruiter projects create |
| Flag | Description |
|---|---|
--stage | Read only this stage: uncontacted, contacted, replied or archived. Omit it to read all stages. |
--limit | Number of candidates to return, 1–1000; default 25. |
Reading behaviour
- Pages. The action reads the pipeline page by page until it has
limitcandidates or the pipeline ends. If a page does not change after its Next click, or still shows the previous rows, the action fails rather than return a short list. - Empty. An empty project, or an empty stage, succeeds with an empty
dataarray. - No limit category. Reading a pipeline does not open profiles and does not count against
rcPersonProfileViews.
Result options
- Successful reading:
{
"actionType": "rc.retrieveProjectCandidates",
"label": "pipeline",
"success": true,
"data": [
{
"name": "Jane Example",
"recruiterProfileUrl": "https://www.linkedin.com/talent/profile/AEMAAB0xExampleProfileId1",
"headline": "Data Engineer at Example Logistics",
"location": "Amsterdam, North Holland, Netherlands",
"avatarUrl": null,
"viewerState": { "connectionDegree": "2nd" },
"stage": "uncontacted"
}
]
}| Field | Meaning |
|---|---|
name | Candidate's full name. |
recruiterProfileUrl | Candidate's Recruiter profile, https://www.linkedin.com/talent/profile/…, without query parameters. Pass it as personUrl to rc.openPersonPage. |
headline | Headline as the pipeline shows it, or an empty string. |
location | Location as the pipeline shows it, or an empty string. |
avatarUrl | Profile photo URL, or null without a photo. |
viewerState.connectionDegree | 1st, 2nd or 3rd+, or null when Recruiter shows none. |
stage | The candidate's stage in this project: uncontacted, contacted, replied or archived. |
label is included only if specified in the action parameters.
- Failed reading:
{
"actionType": "rc.retrieveProjectCandidates",
"label": "pipeline",
"success": false,
"error": {
"type": "projectNotFound",
"message": "The Recruiter project could not be opened or no longer exists."
}
}Possible error.type values:
projectNotFound– the seat cannot open a project with this ID: Recruiter answers with its page-not-found.recruiterSignInRequired,recruiterTwoStepVerificationRequired,recruiterMultipleSessionsDetected– the seat needs attention, see account errors.unexpectedError– the pipeline could not be read completely.