Skip to main content
POST
Search people

Authorizations

​
Authorization
string
header
required

Pass Authorization: Bearer <credential>, where the credential is either:

  • an API key (sk_…), generated by an organization admin in Settings, for scripts and automation;
  • an access token from tth auth login (the TalkToHumans CLI), which any member of the workspace can use.

Both resolve to the same organization and user. A login token acts in the user's workspace: one with no workspace yet returns 403 workspace_setup_required, and one in several workspaces returns 403 forbidden (use an API key instead).

Body

application/json

At least one filter besides exclude, or sales_navigator_url alone. List filters match any of their values, and people must match every filter set.

​
account_id
string

LinkedIn account ID returned by GET /v1/accounts. Required when the organization has multiple LinkedIn accounts.

Pattern: ^[1-9][0-9]*$
​
keywords
string

Words to search for, such as a skill or a name. Supports LinkedIn's AND, OR and NOT.

Maximum string length: 200
​
job_titles
string[]

Current job titles, such as Head of Sales.

Maximum array length: 20
​
past_job_titles
string[]

Past job titles.

Maximum array length: 20
​
company_linkedin_urls
string[]

LinkedIn company page URLs of their current employer, such as https://www.linkedin.com/company/google.

Maximum array length: 20
​
past_company_linkedin_urls
string[]

LinkedIn company page URLs of their past employers.

Maximum array length: 20
​
school_linkedin_urls
string[]

LinkedIn school page URLs, such as https://www.linkedin.com/school/stanford-university.

Maximum array length: 20
​
locations
string[]

Locations, such as Paris or United States.

Maximum array length: 20
​
industries
string[]

Industries of their current employer, as LinkedIn company pages name them, such as Software Development or Financial Services. An unknown one fails with the closest names.

Maximum array length: 20
​
seniorities
string[]

Seniority levels (In Training, Entry Level, Senior, Strategic, Entry Level Manager, Experienced Manager, Director, Vice President, CXO or Owner / Partner).

Maximum array length: 20
​
company_sizes
string[]

Employee counts of their current employer (self-employed, 1-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000 or 10001+).

Maximum array length: 20
​
languages
string[]

Languages of their LinkedIn profile (Arabic, Bahasa Indonesia, Chinese, Czech, Danish, Dutch, English, French, German, Italian, Japanese, Korean, Malay, Norwegian, Polish, Portuguese, Romanian, Russian, Spanish, Swedish, Tagalog or Turkish).

Maximum array length: 20
​
exclude
object

People to leave out, matching any of these values. Values are as in the filters of the same name.

​
sales_navigator_url
string

Sales Navigator lead search URL, copied from the address bar, instead of every other filter. Filters tied to your own Sales Navigator account (lead and account lists, connections, past colleagues, saved leads, lead interactions, personas, profile viewers, company followers, shared experiences) aren't supported.

​
cursor
string

Cursor returned as data.pagination.next_cursor by the previous call, with the same filters. Each page costs credits.

Response

One page of 25 people. They aren't contacts yet: import them with POST /v1/contacts and their linkedin_url. Each page costs 10 credits, nothing when the organization read it within 24 hours.

​
data
object
required