Pagination

Pagination is used whenever SwitchApp returns a lists of items.

All top-level API resources return a paginated list of items as the query response data. This is necessary as the complete list might contain a lot of items, thus returning the entire list at initial request will be suboptimal for resource management.

The response however returns metadata about the total size of the data being queried. To obtain more data from the entire list, you may simply provide the next page number in increments of 1 within the bounds of the total page number.

Below is a sample of the pagination meta returned for an endpoint

meta: {
    page_meta: {
      page: "number",
      page_size: "number",
      search: "text"
    }
  }