recruiter.searchPeople
Requires the Recruiter add-on. Calls return
TIER_NOT_ACTIVE(403) when the seat does not have this add-on active.
Search LinkedIn members using Recruiter filters.
Signature
searchPeople(body: RecruiterSearchPeopleBody, params?: Partial<RecruiterSearchPeopleQuery>): Promise<RecruiterSearchPeopleResult>Example
import { Curviate } from "@curviate/sdk";
const curviate = new Curviate({
apiKey: "cvt_live_…",
baseUrl: "https://api.curviate.com",
});
const result = await curviate.account("acc_YOUR_ACCOUNT_ID").recruiter.searchPeople();
console.log(`SearchPeople: ${result.cursor}`);Parameters
| Name | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque pagination cursor from a previous response. Omit for the first page. |
limit | number | No | Number of results to return (1–100). Defaults to 25. |
keywords | string | No | Free-text keyword search. Content — forwarded verbatim, never persisted. |
spotlights | array | No | Filter by candidate spotlight tags. |
load_saved_search | string | No | Load filters from a saved search id. |
load_custom_filter | string | No | Load filters from a saved custom-filter id. |
save_search | string | No | Persist this search under a name on the LinkedIn side. |
save_custom_filter | string | No | Persist this filter set under a name on the LinkedIn side. |
network_distance | array | No | Filter by network distance. |
location | array | No | Resolved LOCATION parameter ids. |
postal_code | string | No | A postal code to search around. |
postal_code_radius | number | No | Radius (in the substrate's own unit) around postal_code. |
job_title | array | No | Resolved JOB_TITLE parameter ids. |
occupation | array | No | Resolved OCCUPATION parameter ids. |
skills | array | No | Resolved SKILL parameter ids. |
company | array | No | Resolved COMPANY parameter ids. |
current_company | array | No | Resolved CURRENT_COMPANY parameter ids. |
past_company | array | No | Resolved company parameter ids for past employers. |
company_size | array | No | Filter by company size bucket. |
years_of_experience | array | No | One or more {min?,max?} years-of-experience ranges. |
years_in_current_position | array | No | One or more {min?,max?} years-in-current-position ranges. |
years_in_current_company | array | No | One or more {min?,max?} years-in-current-company ranges. |
degree | array | No | Resolved DEGREE parameter ids. |
workplace_type | array | No | Filter by workplace type (e.g. ON_SITE, REMOTE, HYBRID). |
school | array | No | Resolved SCHOOL parameter ids. |
field_of_study | array | No | Resolved FIELD_OF_STUDY parameter ids. |
employment_type | array | No | Filter by employment type. |
graduation_year | array | No | Filter by one or more graduation years. |
industry | array | No | Resolved INDUSTRY parameter ids. |
seniority | array | No | Filter by seniority level. |
spoken_language | array | No | Resolved SPOKEN_LANGUAGE parameter ids. |
profile_language | array | No | Filter by the profile's display language. |
project | string | No | Resolved PROJECT parameter id. |
job_function | array | No | Resolved JOB_FUNCTION parameter ids. |
first_name | string | No | Content — forwarded verbatim, never persisted. |
last_name | string | No | Content — forwarded verbatim, never persisted. |
recently_joined | boolean | No | Filter to members who recently joined LinkedIn. |
is_military_veteran | boolean | No | Filter to members who self-identify as military veterans. |
recruiting_activity | object | No | Include/exclude by recent recruiting activity. |
hide_previously_viewed | boolean | No | Exclude profiles already viewed. |
group | array | No | Resolved GROUP parameter ids. |
is_past_applicant | boolean | No | Filter to members who previously applied. |
notes | string | No | Content — forwarded verbatim, never persisted. |
tags | array | No | Resolved TAG parameter ids. |
Returns
Resolves to RecruiterSearchPeopleResult. Top-level fields: object, data, cursor, total_count.
Error codes
UNAUTHORIZEDINVALID_REQUESTRATE_LIMIT_ACCOUNTRATE_LIMIT_TENANTPLATFORM_RATE_LIMITPLATFORM_ERRORACCOUNT_RESTRICTEDLINKEDIN_AUTH_FAILEDLINKEDIN_FEATURE_NOT_SUBSCRIBEDRESOURCE_NOT_FOUNDTIER_NOT_ACTIVE
All error codes link to Error codes reference.
Notes
Note: The
account_idis injected automatically by the account-scoped accessor. Call ascurviate.account("acc_YOUR_ACCOUNT_ID").recruiter.searchPeople(...).