Pagination

In this guide, we will look at how to work with paginated responses when querying the VaporCMS API. By default, all responses limit results to ten. However, you can go as high as 100 by adding a pageSize parameter to your requests.

When an API response returns a list of objects, no matter the amount, pagination is supported. In paginated responses, we return a pagination object, which contains the needed information to get the next page.

Example using pagination

curl -G https://api.vaporcms.com/v0/{blogId}/articles \
  -H "Authorization: Bearer {token}" \
  -d page=1 \
  -d pageSize=100

{
    "articles": [
        {
            "id": "cm1uxrqxv000ife8jjwweuu87",
            ...
        },
        {
            "id": "cm1uxrqxv000ife8jjwweuu17",
            ...
        },
        ...
    ],
    "totalCount": 500,
    "pagination": {
        "page": 1,
        "pageSize": 100,
        "totalPages": 5
    }
}