Pagination

All collection endpoints (e.g. GET /clients) are paginated, usually returning 50 items by default. The amount can be increased through the limit parameter, with 200 max.

The API response will indicate whether more records are available through a next_cursor property in the JSON response body (using cursor-based pagination).

Request:

curl \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept-Version: 1.0.0' \
  https://api.firmcheck.com/clients

Response:

{
  "data": [
    {
      "id": "ABC",
      "object": "client"
    },
    {
      "id": "DEF",
      "object": "client"
    },
  ],
  "meta": {
    "next_cursor": "MTc0NTg3NDc0MTgyOC16eHFsMmptcjloc3U2aDBoZGMzMTlkNmM=",
    "total": 8
  }
}

In order to get more results, you need to pass through the next_cursor from the response as the cursor parameter in your next request.

Next request:

curl \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept-Version: 1.0.0' \
  https://api.firmcheck.com/clients?cursor=MTc0NTg3NDc0MTgyOC16eHFsMmptcjloc3U2aDBoZGMzMTlkNmM

When no further items are available, the next_cursor value will be undefined