Skip to main content
Most list endpoints in the Zeeg API return paginated results. Instead of returning every record at once, responses are split into pages that you can iterate through.

Parameters

Every paginated endpoint accepts the following query parameters:
ParameterTypeDefaultDescription
countinteger20Number of items per page. Min 1, max 100.
pageinteger1The page number to retrieve (1-indexed).
The /organizations/users endpoint uses per_page instead of count. All other paginated endpoints use count.

Response structure

Paginated responses include a collection array with the requested items and a pagination object with metadata for navigating between pages.
{
  "collection": [
    { "...": "..." }
  ],
  "pagination": {
    "total": 42,
    "count": 20,
    "totalPages": 3,
    "previousPage": "/v2/scheduled-events?page=1",
    "currentPage": 2,
    "nextPage": "/v2/scheduled-events?page=3"
  }
}
pagination.total
integer
The total number of items across all pages.
pagination.count
integer
The number of items returned in the current page.
pagination.totalPages
integer
The total number of pages available.
pagination.previousPage
string | null
The path to the previous page of results. null when you are on the first page.
pagination.currentPage
integer
The current page number.
pagination.nextPage
string | null
The path to the next page of results. null when you are on the last page.

Iterating through pages

Use nextPage to walk through all pages until it returns null.
# Fetch page 1
curl "https://api.zeeg.me/v2/scheduled-events?count=20&page=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

# Fetch the next page
curl "https://api.zeeg.me/v2/scheduled-events?count=20&page=2" \
  -H "Authorization: Bearer YOUR_TOKEN"
Use a smaller count (e.g. 10) if you need faster individual responses, or a larger count (up to 100) to reduce the total number of requests.
Last modified on April 4, 2026