salesNavigator.searchPeople
Requires the Sales Navigator add-on. Calls return
TIER_NOT_ACTIVE(403) when the seat does not have this add-on active.
Search LinkedIn members using the full Sales Navigator filter set.
Signature
searchPeople(body: SNSearchPeopleBody, query?: Partial<SNSearchPeopleQuery>): Promise<SNSearchPeopleResult>Example
import { Curviate } from "@curviate/sdk";
const curviate = new Curviate({
apiKey: "cvt_live_…",
baseUrl: "https://api.curviate.com",
});
const page = await curviate.account("acc_YOUR_ACCOUNT_ID").salesNavigator.searchPeople();
for (const item of page.items ?? []) {
console.log(item.id);
}
// `page.cursor` is the opaque cursor for the next page (null when exhausted).Parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit | number | No | Number of results to return (1–100). Default 25. |
cursor | string | No | Opaque pagination cursor from a previous response. |
keywords | string | No | Free-text keyword filter. |
current_company | object | No | Current-employer COMPANY parameter IDs to include or exclude. |
past_company | object | No | Past-employer COMPANY parameter IDs to include or exclude. |
company_location | object | No | LOCATION parameter IDs for the current company's HQ to include or exclude. |
account_list | object | No | ACCOUNT_LIST parameter IDs to include or exclude. |
function | object | No | JOB_FUNCTION parameter IDs to include or exclude. |
current_job_title | object | No | Current-role JOB_TITLE parameter IDs to include or exclude. |
past_job_title | object | No | Past-role JOB_TITLE parameter IDs to include or exclude. |
persona | array | No | PERSONA parameter IDs to filter by. |
location | object | No | LOCATION parameter IDs to include or exclude. |
postal_code | object | No | POSTAL_CODE parameter IDs to include or exclude, plus an optional radius in miles. |
industry | object | No | INDUSTRY parameter IDs to include or exclude. |
group | object | No | GROUP parameter IDs to include or exclude. |
school | object | No | SCHOOL parameter IDs to include or exclude. |
profile_language | array | No | PROFILE_LANGUAGE parameter IDs to filter by. |
lead_list | object | No | LEAD_LIST parameter IDs to include or exclude. |
seniority | object | No | Seniority levels to include or exclude. |
company_headcount | array | No | Company headcount ranges. |
years_in_company | array | No | Years-in-current-company ranges. |
years_in_position | array | No | Years-in-current-position ranges. |
years_of_experience | array | No | Total years-of-experience ranges. |
company_type | array | No | Company type filter. |
network_distance | array | No | Connection distance: 1 (1st), 2 (2nd), 3 (3rd+), 'GROUP' (group members). |
connections_of | array | No | PEOPLE parameter IDs — return connections of these members. |
first_name | array | No | First names to filter by. |
last_name | array | No | Last names to filter by. |
recent_interaction | object | No | Filter by recent interaction with the operator account. |
saved_resources | object | No | Include results from the operator's saved leads/accounts. |
save_search | object | No | Save this search with the given name for later retrieval. |
load_saved_search | object | No | Load and run a previously saved search by ID. |
load_recent_search | object | No | Load and run a recent search by ID. |
following_your_company | boolean | No | Filter to members following your company. |
viewed_your_profile_recently | boolean | No | Filter to members who viewed your profile recently. |
past_colleague | boolean | No | Filter to past colleagues. |
shared_experiences | boolean | No | Filter to members with shared experiences. |
changed_jobs | boolean | No | Filter to members who recently changed jobs. |
posted_on_linkedin | boolean | No | Filter to members who recently posted on LinkedIn. |
Returns
Resolves to SNSearchPeopleResult. Top-level fields: object, items, paging, cursor.
Error codes
UNAUTHORIZEDINVALID_REQUESTRATE_LIMIT_ACCOUNTRATE_LIMIT_TENANTPLATFORM_RATE_LIMITPLATFORM_ERRORACCOUNT_NOT_FOUNDLINKEDIN_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").salesNavigator.searchPeople(...).