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.*

TypeDescription
ObjectThe matched profile in the format described in our Person Schema.

The data object contains the entire PDL profile for the person that matches the Search API request. Any profile field that we do not have data for will have a null value.


status

TypeDescription
IntegerThe API response code.

total

TypeDescription
IntegerThe total number of records that matched the input query.

scroll_token

TypeDescription
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.