Output Response - Person Search API

Detailed information on Person Search API response

Response Data Structure

The response from the Person Search API will be in this format:

{
    "status": 200,
    "data": [
        {
            "id": "qEnOZ5Oh0poWnQ1luFBfVw_0000",
            "full_name": "sean thorne",
            ...
        },
        ...
    ],
    "scroll_token": "1117$12.176522",
    "total": 99
}

See Example Person Record for a full example of the fields included in the data object.

Response Fields

`data.*`

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

The data list is made up of objects that contain the entire PDL profile for each person 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 4 months ago