Pagination

In this guide, we will look at how to work with paginated responses when querying the eeds API. By default, most responses return 20 results at a time. However, you can return as many as 100 results by adding a perPage parameter to your requests.

In paginated responses, objects are nested in a data attribute and include metadata that includes the total number of results, the current page, the total number of pages, and the number of results returned per page.

Example using page configuration

In this example, we request 30 results per page and the fourth page of results. We can compare the value of the currentPage attribute to the value of the totalPages attribute to know when we have reached the end of the resultset.

Name
page
Type
number
Description
The page from the resultset to return.
Name
perPage
Type
number
Description
The number of results to return per page.

Pagination using cURL

curl -G https://newapi.eeds.com/api/conferences \
  -H "Authorization: Bearer {token}" \
  -d page=4 \
  -d perPage=30

Paginated response

{
  "pageSize": 30,
  "currentPage": 4,
  "totalItems": 679,
  "totalPages": 23,
  "data": [
    {
      "id": "WAz8eIbvDR60rouK",
      // ...
    },
    {
      "id": "hSIhXBhNe8X1d8Et"
      // ...
    },
    {
      "id": "fbwYwpi9C2ybt6Yb"
      // ...
    }
  ]
}