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.*
data.*
Type | Description |
---|---|
Object | The matched profile in the format described in our Company Schema. |
The data
object contains the entire PDL profile for the company that matches the Search API request. Any profile field that we do not have data for will have a null
value.
status
status
Type | Description | |
---|---|---|
Integer | The API response code. |
total
total
Type | Description |
---|---|
Integer | The total number of records that matched the input query. |
scroll_token
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 about 2 months ago