Skip to main content
POST
Find by details

Authorizations

X-API-KEY
string
header
required

Body

application/json

Request body for finding people. Each field is optional. However, you must provide at least one field to perform a valid search. The values a filter accepts can be listed with GET /v1/knowledge-graph/people/values/{filter}.

query
string

Text query to search for people by name or description. Examples: 'Tim Cook', 'Christine Lagarde'

Example:

"Tim Cook"

positions
string[]

Positions, as published in the position field of results (e.g., 'Chief Executive Officer')

Example:
employers
string[]

Employers, as published in the employer field of results (e.g., 'Apple Inc.')

Example:
nationalities
string[]

Nationalities, as published in the nationality field of results (e.g., 'American')

Example:
genders
string[]

Genders, as published in the gender field of results (e.g., 'Male', 'Female')

Example:

Response

200 - application/json

Successful response with people data

Response containing people results and metadata

results
object[]
required

Array of people results

metadata
object
required
usage
object

Optional. Present for token-billing accounts only. Reports the number of tokens consumed by this request.