LinkedIn API
LinkedIn people search
People matching a name with optional title, location, company, school and industry filters: handle, headline, location, followers and badges.
Endpoint
GET/v1/linkedin/search-peoplelive · proven8 creditsParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
query | no | A person's name | Bill Gates |
title | no | Job title filter | |
location | no | A location id from linkedin/search-locations | |
current_company | no | Current company filter | |
past_company | no | Past company filter | |
school | no | A school id from linkedin/search-schools | |
industry | no | An industry id from linkedin/search-industries | |
page | no | Page number | 1 |
search_url | no | Alternative to query: a public LinkedIn people-search URL with keywords. Single selected location, company, school, industry and language filters are supported. Multiple selections, network/Sales Navigator filters and filter-only searches are rejected before source calls. This translates supported filters; it does not use your LinkedIn login. | https://www.linkedin.com/search/results/people/?keywords=Bill%20Gates |
dry_run | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. | 1 |
judgments | no | Add bounded AI labels to eligible returned records (default on). off preserves the original data shape. Unclassified records remain present; labels depend on evidence, time, capacity and the existing request budget. No label surcharge. | on |
label | no | Set none to disable labels; default enables the endpoint’s label set. Equivalent to judgments=off. | none |
label_evidence | no | Include exact supporting sentences and zero-based sentence indexes when a label has validated evidence. No extra charge or change to decisions. | 1 |
exclude | no | Optionally remove confidently labelled engagement bait. Uncertain and unclassified records stay; removed IDs and an owner-bound recall reference are returned. | engagement_bait |
fit | no | Use goal to replace confidently irrelevant records with recall stubs. Keeps first, last, relevant and uncertain records; preserves order. Full evidence is stored for 24 hours when available. | goal |
goal | no | Required with fit=goal: describe the task in at most 600 characters. Supplied text is task context, never permission to act on posts. | Find concrete product complaints |
tokens | no | Optional soft response target for fit=goal, 256–32000. Safety and evidence retention take priority, so the returned result may exceed it. | 4000 |
geocode_location | no | Compatibility alias for location. The canonical parameter takes precedence if both are supplied. | |
Examples
Make the request
curl "https://www.monocrawl.com/v1/linkedin/search-people?query=Bill%20Gates" \ -H "x-api-key: mn_your_key_here"
TypeScript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
"https://www.monocrawl.com/v1/linkedin/search-people?query=Bill%20Gates",
{ headers: { "x-api-key": key } },
);
const body = await res.json();
if (!body.success) {
// one error shape for every endpoint — see /docs/errors
throw new Error(`${body.error.type}: ${body.error.message}`);
}
console.log(body.data, "credits left:", body.credits_remaining);Python
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/linkedin/search-people?query=Bill%20Gates",
headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
timeout=60,
)
body = res.json()
if not body["success"]:
# one error shape for every endpoint — see /docs/errors
raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")
print(body["data"], "credits left:", body["credits_remaining"])Response
Response fields and example
This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.
{
"success": true,
"platform": "linkedin",
"endpoint": "/v1/linkedin/search-people",
"data": {
"items": [],
"count": 0
},
"credits_used": 8,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.
Schema basis: reviewed response shaper. See schema coverage and validation limits.
Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.
| Field inside data | Type | Meaning |
|---|---|---|
items | array | Nested response fields; optional unless explicitly documented. |
items[].id | string | null | Exact source identifier; preserve it as a string. |
items[].handle | string | null | handle |
items[].name | string | null | name |
items[].url | string | null | url |
items[].headline | string | null | headline |
items[].location | string | null | location |
items[].avatar_url | string | null | avatar url |
items[].followers | number | null | Public follower count. |
items[].verified | boolean | null | Explicit verification flag when supplied. |
count | number | null | Returned rows, not the total population. |
cursor | string | null | Opaque continuation; pass unchanged. |
has_more | boolean | null | Source continuation indicator. |
total | number | null | Source-reported total; null means unknown. |
Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference