Pagination

Many top-level API resources have support for bulk fetches via “list” API methods. These list API requests share a common structure, taking at least these two parameters: limit and cursor. The responses also share a common structure having data as an array of items, and metadata containing nextCursor.

Parameters

ParameterRequiredDefaultDescription
Limitfalse10A limit on the number of items to be returned, between 1 and 100.
cursorfalseA cursor for use in pagination. cursor is an opaque string that defines your place in the list. List response metadata will contain a nextCursor and previousCursor that can be used to move forwards or backwards on a subsequent request.

Response metadata

FieldDescription
nextCursorCan be used in subsequent requests to paginate forwards.



{
  "data": [
    {},
    {}
  ],
  "metadata": {
    "nextCursor": "f2d78bd077984ca99ce29c51b68e51a249f56e4d5"
  }
}