This page documents the canonical HTTP contract. Switch to the CLI example when you want the operator workflow.
When to use this: choose people search when you already know the target company or want contacts matching a semantic responsibility description.
Supply the required person_description in natural language. A title can express function and seniority, but is not treated as an exact-string match. Use company for one intended company, domain when known, and location only when geography materially disambiguates the search.
This operation charges one credit per neural people-search API call. The response credits_used and pricing_rule record the applied charge.
Not for: connected-account LinkedIn workflows, Sales Navigator URL replay, or post engagement lists. Use the LinkedIn integration for those cases.
Body parameters
company· optionalstring | null
Provide one intended company name or identity for this lookup. This field is not a collection of parent companies. Do not join multiple company names.
domain· optionalstring | null
Optional company domain.
limit· optionalinteger
Maximum people to return. Default: 10. Range: 1–10. default: 10; maximum: 10; minimum: 1
location· optionalstring | null
Optional geographic context for this people lookup. Use for an explicit person-location requirement or a material disambiguator of the intended person or company; clarify its subject from the request and context. A named business market does not itself require the person to be based there. Do not default this from row country or HQ, and do not copy city or country into person_description. Public-profile location does not verify operating-site activity.
person_descriptionrequiredstring
Semantic description of the person or responsibility to find, phrased like 'person responsible for ...'. A job title is seniority and function intent, not an exact string to match.
| Name | Type | Description |
|---|---|---|
| company | string | null | Provide one intended company name or identity for this lookup. This field is not a collection of parent companies. Do not join multiple company names. |
| domain | string | null | Optional company domain. |
| limit | integer | Maximum people to return. Default: 10. Range: 1–10. default: 10; maximum: 10; minimum: 1 |
| location | string | null | Optional geographic context for this people lookup. Use for an explicit person-location requirement or a material disambiguator of the intended person or company; clarify its subject from the request and context. A named business market does not itself require the person to be based there. Do not default this from row country or HQ, and do not copy city or country into person_description. Public-profile location does not verify operating-site activity. |
| person_descriptionrequired | string | Semantic description of the person or responsibility to find, phrased like 'person responsible for ...'. A job title is seniority and function intent, not an exact string to match. |
Errors
| Status | Meaning |
|---|---|
| 422 | person_description is required and must not be blank; limit must be 1–10. |
| 401 | Invalid API key or missing auth. |
| 403 | Missing search:run scope. |
