salesNavigator.searchPeople
Search LinkedIn members using the full Sales Navigator filter set.
Prerequisites
- A Curviate API key, passed as
apiKeywhen you construct the client. Authentication and accounts shows how to create one. - A connected LinkedIn account. This resource is account-scoped: the
account_idis injected automatically by the account-scoped accessor, so you pass it once tocurviate.account(...)and every call below inherits it. Authentication and accounts covers connecting one, and accounts.list returns theaccount_idof each account already connected. - Requires the Sales Navigator add-on on the seat. Without it, calls return
TIER_NOT_ACTIVE(403).
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({ keywords: "YOUR_KEYWORDS" });
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 used to filter to 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
| Code | What it means, and what to do |
|---|---|
UNAUTHORIZED | The API key is missing, malformed, or revoked. Check the key you passed to the client. |
INVALID_REQUEST | A parameter failed validation. The message names the offending field; fix the request rather than retrying it. |
RATE_LIMIT_ACCOUNT | This account's own quota is exhausted. Wait for the window in the Retry-After header, then retry. |
RATE_LIMIT_TENANT | The tenant-wide quota is exhausted across all accounts. Slow the whole workload, not just this call. |
PLATFORM_RATE_LIMIT | LinkedIn is throttling this account. Back off well beyond the hinted delay; sustained pressure risks the account. |
PLATFORM_ERROR | A transient upstream failure. Retry once with backoff before treating it as a real error. |
ACCOUNT_NOT_FOUND | No connected account with that id belongs to this tenant. List your accounts to get a current id. |
LINKEDIN_FEATURE_NOT_SUBSCRIBED | The seat has the add-on but the LinkedIn account itself lacks the underlying subscription. |
RESOURCE_NOT_FOUND | The id in the path does not exist, or is not visible to this account. Re-read it from the list endpoint that produced it. |
TIER_NOT_ACTIVE | The seat does not have the add-on this endpoint needs. Enable it on the seat, then retry. |
Every code above is a stable CurviateError.code you can branch on. The full list, the response envelope, and retry semantics are in the Error codes reference.
Next steps
salesNavigator.getParameters: resolve a human term into the opaque parameter ids the filters above take. Resolve first, then filter.salesNavigator.searchCompanies: Search LinkedIn companies using the full Sales Navigator company filter set.salesNavigator.searchFromUrl: Run a pasted Sales Navigator search/list URL directly.- SDK Quick Start: installation, the client, account scoping, and pagination.