Pagination

Collection operations commonly use page-number pagination. Supply the page in page[number] and the requested number of resources in page[size].

Parameters

page[number]positive integeroptional

The one-based page number. The default is normally 1.

page[size]positive integeroptional

The number of resources requested per page.

Default and maximum page sizes are resource-specific. Some older collection operations clamp an oversized page, while newer operations reject it. The operation page documents the behavior to rely on.

Response metadata

Most paginated resources return the selected page and total count in a nested meta.page object. Some resources use flat meta.page, meta.size, and meta.total members instead.

Use the response format shown by the resource operation. Do not infer that a short page is the final page when meta.total is available.

Iteration

Start at page 1, retain the page size, and increment page[number] until the requested range reaches meta.total. Do not request multiple pages concurrently unless the integration can tolerate records moving between pages during the read.

Paginated request

curl --get https://api.celula.in/v1/courses \
  --header "X-CIN-API-Token: $CELULAIN_CLIENT_TOKEN" \
  --header "Authorization: Bearer $CELULAIN_ACCESS_TOKEN" \
  --header "Accept: application/vnd.api+json" \
  --data-urlencode "page[number]=2" \
  --data-urlencode "page[size]=50"

Nested page metadata

{
  "data": [],
  "meta": {
    "page": {
      "number": 2,
      "size": 50
    },
    "total": 73
  }
}

Legacy flat metadata

{
  "data": [],
  "meta": {
    "page": 2,
    "size": 50,
    "total": 73
  }
}