---
agentTools:
  projectIndex: https://developer.authvia.com/llms.txt
---

# Standardize Pagination

In an effort to make our API more user-friendly, our pagination implementation has been standardized to facilitate usage from one endpoint to the next.

To navigate through paginated results, clients can follow the link provided in the `X-LINK` header, updating the `pageKey` parameter to the value specified in the `X-PAGE-KEY` header and maintaining the `pageSize` parameter as specified in the `X-PAGE-SIZE` header.

> 📘 Notes
>
> * The `rel="next"` attribute in the `X-LINK` header indicates that the linked URL is for the next page of results. Clients should use this link for subsequent requests to retrieve the next set of items.
> * The X-LINK header retains any query parameters from the previous request. This ensures continuity between paginated responses, maintaining the original query parameters in subsequent requests for accurate pagination and filtering.

## Query params

| Name       | Description                                                                                                                                                            |
| :--------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *pageSize* | Specifies the maximum number of items to be returned in a single page of pagination. If a larger number is provided, it will be capped at 100. The minimum value is 1. |
| *pageKey*  | This is used to go to the next page of results. It's best to use the x-link header and the 'next' definition, as we've assembled them for you                          |

## Impacted endpoints

* *[List Business Processes](https://developer.authvia.com/v3.3/reference/list-business-processes)*
* *[List Blueprints](https://developer.authvia.com/v3.3/reference/list-blueprints)*
* *[List Triggers](https://developer.authvia.com/v3.3/reference/list-triggers)*
* *[List Customers](https://developer.authvia.com/v3.3/reference/list-customers)*
* *[List Subscription Events](https://developer.authvia.com/v3.3/reference/get-subscription-events-list)*

# Standard Overview

> 🚧 Warning: Currently, there is a known issue where the generated *X-LINK* header fails to preserve the query parameters from the original request.

### Endpoint:

* /resource

### Response:

#### Status code:

* 200

#### Body

* The response body will contain an array of requested items and be empty if no results exist.

#### Response Headers:

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Name
      </th>

      <th>
        Description
      </th>

      <th>
        Example
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        *X-PAGE-KEY*
      </td>

      <td>
        The key for the next page of results.
      </td>

      <td>
        eyJkYXRhIjogIjIwMjItMDItMjFUMDk6NTk6MDEuNT
      </td>
    </tr>

    <tr>
      <td>
        *X-PAGE-SIZE*
      </td>

      <td>
        The number of items per page.
      </td>

      <td>
        100
      </td>
    </tr>

    <tr>
      <td>
        *X-LINK*
      </td>

      <td>
        The linked URL is for the next page of results.
      </td>

      <td>
        [https://authvia.com/\<version](https://authvia.com/\<version)\
        /resource?pageKey=\<>\&pageSize=10; rel="next">
      </td>
    </tr>

    <tr>
      <td>
        *X-COUNT*
      </td>

      <td>
        Number of items returned in response.
      </td>

      <td>
        100
      </td>
    </tr>
  </tbody>
</Table>