Developers

Pagination

Lists that can grow large use cursor pagination. Cursors stay correct while new records are added, unlike page numbers.

How it works

  1. Request the first page, optionally with limit.
  2. The response contains the records and a nextCursor.
  3. Pass nextCursor as the cursor query parameter to get the next page. Keep every other filter the same.
  4. When nextCursor is null, you have reached the last page.

Treat cursors as opaque strings: don’t build or change them yourself.

shell
curl "https://api.credchek.com/v1/products?limit=100" -H "X-Api-Key: $CREDCHECK_API_KEY"
# { "data": [ … ], "nextCursor": "3f1c…" }

curl "https://api.credchek.com/v1/products?limit=100&cursor=3f1c…" -H "X-Api-Key: $CREDCHECK_API_KEY"
# { "data": [ … ], "nextCursor": null }

Paginated lists

EndpointRecords fieldDefault limitMaximum limit
GET /v1/productsdata24100
GET /v1/codesdata50100
GET /v1/analytics/eventsdata50100
GET /v1/fraud/alertsitems50100
GET /v1/reportsitems50100

Short lists, such as a product’s batches and recent generation jobs, return { "data": [ … ] } without a cursor.

With the SDK

iterate() fetches pages as you loop, so you never handle cursors yourself:

typescript
for await (const product of cc.products.iterate()) {
  console.log(product.sku, product.name);
}

Mind your plan’s rate limit when iterating very large lists.

Next: Idempotency

Pagination · CredChek