Pagination

Parameters

The meta object

{
  "total": 180,
  "rows_per_page": 50,
  "page": 2,
  "total_pages": 4,
  "links": {
    "first-page": {
      "href": "/v1/events?eventType=move&limit=50&page=1",
      "method": "GET"
    },
    "previous-page": {
      "href": "/v1/events?eventType=move&limit=50&page=1",
      "method": "GET"
    },
    "current-page": {
      "href": "/v1/events?eventType=move&limit=50&page=2",
      "method": "GET"
    },
    "next-page": {
      "href": "/v1/events?eventType=move&limit=50&page=3",
      "method": "GET"
    },
    "last-page": {
      "href": "/v1/events?eventType=move&limit=50&page=4",
      "method": "GET"
    }
  }
}

Stop on a short page

Counting every match on a large filter can take longer than the API allows, so on broad queries total and total_pages fall back to an estimate for the whole table. A filter that matches four events can report thousands of pages.

So loop on the page itself. Keep going while a page is full, stop as soon as one returns fewer rows than limit, and set a hard cap on pages so a mistake can't run away. The samples below use 50 rows and a cap of 20 pages.

page=1
while [ "$page" -le 20 ]; do
  body=$(curl -sS -G "https://api.chikaraintel.com/v1/events" \
    -H "Authorization: Bearer $CHIKARA_API_TOKEN" \
    --data-urlencode "eventType=move" \
    --data-urlencode "limit=50" \
    --data-urlencode "page=$page")
  rows=$(echo "$body" | jq '.success | length')
  echo "$body" | jq -c '.success[]'
  [ "$rows" -lt 50 ] && break
  page=$((page + 1))
done

Endpoints that don't paginate

Single-record endpoints return meta: null. So do GET /v1/organisations/{organisationReference}/people and the two ownership endpoints, which return everything in one response.