--- title: "List pipeline candidates" method: POST path: "/v1/{account_id}/recruiter/projects/{project_id}/pipeline" tags: ["Recruiter: Projects"] --- # List pipeline candidates `POST /v1/{account_id}/recruiter/projects/{project_id}/pipeline` ## Request - Base URL: `https://api.curviate.com` - URL: `https://api.curviate.com/v1/{account_id}/recruiter/projects/{project_id}/pipeline` - Auth: HTTP bearer List candidates in a Recruiter project's pipeline. A POST body carries the (all-optional) filter set, keywords, stage, sort, spotlights, recruiting activity, skills, experience, and more. Pagination is driven by the limit (1-5000) and cursor query params. Requires a Recruiter seat. ## Path parameters - `account_id` string, required - `project_id` string, required ## Query parameters - `limit` integer - `cursor` string ## Request body - object - `keywords` string - `stage_id` string: Filter to a single pipeline stage id. - `sort_by` 'LAST_MODIFIED' | 'ALPHABETICAL': Sort field. One of: LAST_MODIFIED, ALPHABETICAL. - `spotlights` string[]: Filter by candidate spotlight. One or more of: OPEN_TO_WORK, ACTIVE_TALENT, MISSED_CANDIDATES. - `recruiting_activity` object: Include/exclude by recent recruiting activity. - `include` object - `timespan` string - `activity_types` string[] - `exclude` object - `timespan` string - `activity_types` string[] - `added_by` string[]: Filter by the recruiter(s) who added the candidate. - `skills` string[]: Filter by resolved skill parameter ids. - `years_of_experience` object[]: Filter by one or more {min?,max?} years-of-experience ranges. - `min` integer - `max` integer - `job_title` string[]: Filter by resolved job-title parameter ids. - `current_company` string[]: Filter by resolved company parameter ids. - `current_location` string[]: Filter by resolved location parameter ids. ## Response `200` List of candidates in the project's pipeline, matching any supplied filters. Requires a Recruiter seat. - object - `object` 'recruiter_pipeline_candidate_list', required: Response type discriminator. - `data` object[], required: Pipeline candidate items. - `object` 'recruiter_pipeline_candidate', required: Response type discriminator. - `candidate_id` string, required - `is_hidden_candidate` boolean, required - `hiring_project` object - `id` string - `name` string - `pipeline_stage` string - `profile` object, required - `visibility` 'partial' | 'full', required: Profile detail level. - `id` string, required: Provider identifier. - `network_distance` string, required: SCREAMING_CASE network-distance enum. - `headline` string: The member's headline. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. - `location` string - `can_send_inmail` boolean - `candidate_id` string, required - `is_hidden_candidate` boolean, required - `hiring_project` object - `id` string - `name` string - `pipeline_stage` string - `work_experience` object[], required - `company` object - `id` string - `name` string - `job_title` string - `started_on` string - `ended_on` string - `employment_type` string - `workplace_type` string - `display_name` string: The member's display name. A people search or a talent-pool search stores it in your tenant's entity records, with no expiry. A pipeline read, an applicant read and a pasted-URL search store nothing. - `public_identifier` string - `profile_url` string - `public_picture_url` string - `public_picture_url_large` string - `member_id` string - `industry` string - `relations_count` number - `followers_count` number - `summary` string: Content, not stored. - `emails` string[]: PII, full variant only, never persisted/logged. - `phone_numbers` string[]: PII, full variant only, never persisted/logged. - `skills` object[] - `name` string - `endorsement_count` number - `cursor` string: Opaque cursor for the next page. Absent when there are no more results. - `total_count` number: Total number of matching candidates, when the platform returns it. - `safety_warning` SafetyWarning: Present on a successful response when this account crossed an account-safety ceiling while the affected budget row is on the default warn posture. The action still happened. Field-identical to the BUDGET_EXHAUSTED error body except that blocked is false and hint.message describes the outcome, so one branch handles both postures and switching the account to enforce is a configuration change rather than a client rewrite. - `row` string, nullable, required: The budget row that breached, for example profile_views or pending_invites. Null when the breach is not about a row: an activity_window warning on an action that spends no budget of its own (editing a message, dismissing a notification, a Recruiter or Sales Navigator admin action) is still governed by the hours the account works in. Read hint.parameter for what to change; whenever this is null it names posture, because the activity window edges are set per action type and this action has none, so the levers that reach it are the account timezone and posture. - `reset_at` string, nullable, required: The instant the refusal lifts: the window roll on a ceiling refusal, the next window open on an activity-window one. Null in the two cases no clock frees, the pending_invites gauge and InMail credits (row inmail). - `hint` object, required - `parameter` string, required: The settable parameter on PATCH /v1/{account_id}/safety-policy. - `message` string, required: What the condition is and what changing that parameter would do. This is the one field whose text differs from the BUDGET_EXHAUSTED refusal: here it says the action went through, and on a ceiling breach how far past the ceiling this row now stands, rather than telling you to set posture to warn when it already is. Branch on parameter, reason and blocked, never on this text. - `reason` 'ceiling' | 'activity_window', required: Which rule was crossed. ceiling means the row's configured limit is spent; activity_window means the account is outside the hours it works in, which is a different fact with a different remedy. hint.parameter names the right setting for each. - `blocked` boolean, required: Always false here. True on the BUDGET_EXHAUSTED refusal carrying the same payload. ## Other responses - `400`: Invalid request, an over-cap limit, a malformed cursor, an unknown status/sort_by value, or another validation error. - `401`: LINKEDIN_AUTH_FAILED, missing or invalid API key, or the LinkedIn account is disconnected. - `403`: Forbidden. Either NO_ACTIVE_SEAT (the account is not attached to an active seat), or LINKEDIN_FEATURE_NOT_SUBSCRIBED (the connected LinkedIn account lacks the Recruiter subscription; activate it on LinkedIn, reconnecting will not help). The code field distinguishes the two. - `404`: Not found. RESOURCE_NOT_FOUND, the project_id does not exist or is not visible to this account. ACCOUNT_NOT_FOUND, the account_id does not exist or does not belong to this tenant. An id whose connection was replaced or removed also stops resolving here, and it is already absent from the list, so re-read `GET /v1/accounts` for the current id. - `413`: Payload too large, the request body exceeds the size limit. - `422`: Unprocessable entity, the account or project state is invalid for this operation. - `429`: RATE_LIMIT_ACCOUNT, too many requests. Retry with exponential backoff. - `500`: Internal server error. - `502`: PLATFORM_ERROR. A temporary error occurred. Typically temporary. - `503`: Service unavailable, the platform service is temporarily down. - `504`: Gateway timeout, the request timed out. --- [API](https://skmtc.dev/curviate/apis/curviate-api.md) · [All operations](https://skmtc.dev/curviate/apis/curviate-api/llms.txt) · [OpenAPI document](https://skmtc.dev/curviate/apis/curviate-api/revisions/eab848801d95?raw)