> For the complete documentation index, see [llms.txt](https://tristans-organization-4.gitbook.io/attuitive/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tristans-organization-4.gitbook.io/attuitive/api-reference/pagination.md).

# Pagination

Some resources return collections of data and hence support pagination to chunk these results as they are returned. These results follow a standard approach.

For pagination-enabled endpoints, collections will be returned within a `data` property. This is a JSON array of results that can be iterated through. A `meta` property holds pagination information such as `nextPageUrl`, `previousPageUrl`, and `limit`.

```json
{
  "data": [
    {
      ...
    }
    ...
  ],
  "meta": {
    "limit": 50,
    "nextPageUrl": "/api/v1/identify?limit=50...", // or null
    "previousPageUrl": "/api/v1/identify?limit=50...", // or null
    "url": "/api/v1/identifiy?limit=50"
  }
}
```

### Parameters

| Name        | Type   | Description                                                                                               |
| ----------- | ------ | --------------------------------------------------------------------------------------------------------- |
| `limit`     | number | Maximum number of results to return between `1` & `100`. Defaults to `50`                                 |
| `pageToken` | string | Token for the page to retrieve. Available on requests with multiple pages of results. Starts with `ey...` |

### Response

| Name                   | Type             | Description                                                                |
| ---------------------- | ---------------- | -------------------------------------------------------------------------- |
| `data`                 | array            | Collection of results which varies depending on the resource               |
| `meta`                 | object           | Pagination related details                                                 |
| `meta.limit`           | string           | Number of results requested                                                |
| `meta.nextPageUrl`     | string (or null) | URL to the next page of results or `null` if there is no next page         |
| `meta.previousPageUrl` | string (or null) | URL to the previous page of results or `null` if there is no previous page |
| `meta.url`             | string (or null) | URL to the current page of results.                                        |