> ## Documentation Index
> Fetch the complete documentation index at: https://docs.peopledatalabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Output Response - Person Search API

## Response Data Structure

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

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

See [Example Person Record](https://docs.peopledatalabs.com/docs/example-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](https://docs.peopledatalabs.com/docs/fields). |

The `data` list is made up of objects that contain the entire [PDL profile](https://docs.peopledatalabs.com/docs/fields) for each person that matches the Search API request. Any profile field that we do not have data for will have a `null` value.

<br />

### `status`

| Type      | Description                          |
| :-------- | :----------------------------------- |
| `Integer` | The [API response code](https://docs.peopledatalabs.com/docs/errors). |

<br />

### `total `

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

<br />

### `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](https://docs.peopledatalabs.com/docs/input-parameters-person-search-api#scroll_token).

## Errors

Any request that does not return a `200` success response will instead use the format described in [Errors](https://docs.peopledatalabs.com/docs/errors).