Pagination

Many API resources support bulk fetches through “list” API methods. For example, you can list events, customers, or attendances. These list API methods follow a consistent structure and accept the following parameters: page_size and page.

Our API uses offset-based pagination. You can request specific pages of data using the page parameter, and control the number of results per page using the page_size parameter. The response includes next and previous URLs to simplify pagination for clients.

Paramaters

• page_size: The number of objects to return per page. The default, as well as the max allowed size, is 100.
• page: Specifies the page of results to retrieve. The first page is 1.

Response format

Each paginated API response follows this structure:

{
  "count": 125,
  "next": "https://goteamup.com/api/v2/events?page=3&page_size=25",
  "previous": "https://goteamup.com/api/v2/events?page=1&page_size=25",
  "results": [
    {
      "id": 2452452252,
      "name": "Yoga"
      // More props...
    },
    ...
  ]
}

• count: Specifies the page of results to retrieve. The first page is 1.
• previous: URL to retrieve the next page of results (or null if there is no next page).
• next: URL to retrieve the previous page of results (or null if there is no previous page).
• results: Array of objects returned for the current page.