Skip to main content
POST
Search people
10 Credits Ultra: 50 Credits All plans See the guide for examples and usage.

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <API_KEY>. Keys have full access unless restricted to scopes.

Body

application/json
query
string
required

Describe the people to find. Up to 500 characters in fast mode and 5000 in ultra mode.

Required string length: 1 - 5000
Example:

"VPs of sales at solar companies in California"

mode
enum<string>
default:fast

fast matches people on basic criteria (e.g. their role, location or background); ultra plans a deeper search, judges each candidate against every criterion in the query. Complex ultra searches can take up to 30 seconds to complete, so allow for that in your client timeout.

Available options:
fast,
ultra
filters
object

Additional constraints every result must match.

cursor
string

Use next_cursor with the same query, mode and filters to fetch the next page.

Maximum string length: 65536
tags
string[]

Labels for filtering usage in the dashboard.

Maximum array length: 20
Required string length: 1 - 50
Example:

Response

Successful response

results
object[]
required

Up to 10 matching people, most relevant first.

Maximum array length: 10
request_id
string<uuid>
required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

next_cursor
string | null

Pass as cursor to fetch the next page; null when there are no more results.

key_metadata
object

Credits this request used and your remaining balance.