Output Response - Company Search API

Detailed information on the output response that the Company Search API returns

Response Data Structure

Here is an example response from the Company Search API:

{
    "status": 200,
    "data": [
        {
            "id": "peopledatalabs",
            "name": "people data labs",
            ...
        },
        ...
    ],
    "total": 6,
    "scroll_token": "13.312621$543927"
}

Response Fields

`data.*`

Type	Description
`Array (Object)`	The company response objects that match the input query in the format described in our Company Schema.

The data list is made up of objects that contain the entire PDL profile for each company that matches the Search API request. Any profile field that we do not have data for will have a null value.

`status`

Type	Description
`Integer`	The API response code.

`total`

Type	Description
`Integer`	The total number of records that matched the input query.

`scroll_token`

Type	Description
`String`	The scroll token to use to fetch the next batch of results for the query.

For more information on using scroll_token, see here.

Errors

Any request that does not return a 200 success response will instead use the format described in Errors.

Updated 5 months ago