curl --request POST \
--url https://api.example.com/v2/recruiter \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"account_id": "<string>",
"action": "<string>",
"params": {
"job_id": "<string>",
"count": 123,
"offset": 123
}
}
'{
"success": true,
"data": {
"candidates": [
{
"application_id": "26905743894",
"rating": "UNRATED",
"is_top_choice": false,
"top_choice_message": "",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"headline": "Digital Marketing Strategist | SEO, SEM & Analytics",
"public_identifier": "jane-doe-42",
"profile_url": "https://www.linkedin.com/in/jane-doe-42",
"location": "Paris, France",
"experiences": [
{
"title": "Digital Marketing Intern",
"company": "Acme Corp",
"company_url": "https://www.linkedin.com/company/acme-corp/",
"date_range": "2/2025 - 7/2025",
"description": ""
}
]
}
],
"total_results": 1,
"total_available_results": 81,
"pagination": {
"offset": 0,
"count": 1,
"next_offset": 1,
"has_more": true,
"results_per_page": 50,
"pages_fetched": 1
}
},
"metadata": {
"action": "get_candidates",
"account_id": "your-account-id",
"credits_consumed": 1,
"timestamp": "2026-04-26T10:35:00Z"
}
}
Retrieve candidates who applied to a specific job posting.
curl --request POST \
--url https://api.example.com/v2/recruiter \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"account_id": "<string>",
"action": "<string>",
"params": {
"job_id": "<string>",
"count": 123,
"offset": 123
}
}
'{
"success": true,
"data": {
"candidates": [
{
"application_id": "26905743894",
"rating": "UNRATED",
"is_top_choice": false,
"top_choice_message": "",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"headline": "Digital Marketing Strategist | SEO, SEM & Analytics",
"public_identifier": "jane-doe-42",
"profile_url": "https://www.linkedin.com/in/jane-doe-42",
"location": "Paris, France",
"experiences": [
{
"title": "Digital Marketing Intern",
"company": "Acme Corp",
"company_url": "https://www.linkedin.com/company/acme-corp/",
"date_range": "2/2025 - 7/2025",
"description": ""
}
]
}
],
"total_results": 1,
"total_available_results": 81,
"pagination": {
"offset": 0,
"count": 1,
"next_offset": 1,
"has_more": true,
"results_per_page": 50,
"pages_fetched": 1
}
},
"metadata": {
"action": "get_candidates",
"account_id": "your-account-id",
"credits_consumed": 1,
"timestamp": "2026-04-26T10:35:00Z"
}
}
count for the page size and offset to skip ahead.
count values trigger multiple upstream calls automatically."get_candidates".Show params properties
10. Capped at 1000 per call.0. Use pagination.next_offset from a previous response to fetch the next page.Show data properties
Show candidate properties
get_cv."UNRATED", "GOOD", "MAYBE", "NOT_A_FIT".true when the candidate marked the job as a top choice.title, company, company_url, date_range (e.g. "2/2025 - 7/2025"), description.Show pagination properties
total_results).offset in the next request. null when exhausted.true if more candidates are available.{
"success": true,
"data": {
"candidates": [
{
"application_id": "26905743894",
"rating": "UNRATED",
"is_top_choice": false,
"top_choice_message": "",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"headline": "Digital Marketing Strategist | SEO, SEM & Analytics",
"public_identifier": "jane-doe-42",
"profile_url": "https://www.linkedin.com/in/jane-doe-42",
"location": "Paris, France",
"experiences": [
{
"title": "Digital Marketing Intern",
"company": "Acme Corp",
"company_url": "https://www.linkedin.com/company/acme-corp/",
"date_range": "2/2025 - 7/2025",
"description": ""
}
]
}
],
"total_results": 1,
"total_available_results": 81,
"pagination": {
"offset": 0,
"count": 1,
"next_offset": 1,
"has_more": true,
"results_per_page": 50,
"pages_fetched": 1
}
},
"metadata": {
"action": "get_candidates",
"account_id": "your-account-id",
"credits_consumed": 1,
"timestamp": "2026-04-26T10:35:00Z"
}
}
Was this page helpful?