Skip to main content
POST
Private Company People

Authorizations

X-API-KEY
string
header
required

Body

application/json
identifier
SingleIdentifier · object
required

Object specifying which identifier you are using to request the company profile. You must supply one type and its corresponding value.

limit
integer
default:100

Positions to return, from 1 to 100.

Required range: 1 <= x <= 100
Example:

100

cursor
string | null

Token for the next page. Send back 'pagination.cursor' from the previous response, unchanged and with the same identifier; 'limit' may differ. Omit it for the first page.

Maximum string length: 256

Response

Successful Response

results
PublicPosition · object[]
required

People who hold or held a position at the company, one entry per position, in the order the data provider lists them. A response holds one page; send pagination.cursor back as cursor for the next. Empty when the provider has no positions for the company.

metadata
PublicPeopleMetadata · object
required
errors
ErrorDetail · object[] | null
pagination
Pagination · object | null

Common pagination response for endpoints that support pagination.

sources
Source · object[]

The content catalog sources the response was built from, one entry per source. Empty when no catalog source contributed.

usage
Usage · object | null

Tokens the request consumed, per content tier. Present only for API keys billed in tokens.