Zum Inhalt springen
DebtFlow

Pagination

List endpoints return pages with a cursor. The cursor stays stable even if new entries are added in the meantime.
Query parameterMeaning
limitentries per page, 1 to 100, default 25
cursorvalue of nextCursor from the previous response
Response
{
  "object": "list",
  "data": [ { "id": "…" }, { "id": "…" } ],
  "hasMore": true,
  "nextCursor": "eyJ2IjpbIjIwMjYtMTEtMDQiXSwiaWQiOiJ…"
}
  • hasMore is true as long as further pages follow; nextCursor then contains the cursor for the next page, otherwise null.
  • The cursor is opaque – do not build or parse it yourself. It is only valid together with the same filters as in the first request.
  • An invalid cursor returns 400 validation_error.

Fetching all pages

# first page
curl 'https://www.debt-flow.io/api/v1/contacts?limit=100' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"

# next page, using nextCursor from the previous response
curl 'https://www.debt-flow.io/api/v1/contacts?limit=100&cursor=eyJ2Ijpb…' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"