Pagination

All paginated endpoints support both offset and cursor based pagination. The only important difference is offset pagination only works up to 10,000 results and will return an error for anything higher. For most use cases, you can use offset for convenience. However, if you anticipate having large amounts of data or simply wish to never think about whether or not you data will cross the max threshold offset is supported for, you should use cursor based pagination.

Each endpoint will document the format for offset and cursor based pagination. They're also described here:

  1. Offset based pagination requires you provide a limit and an offset parameter. It will return a hasMore boolean to indicate if more results exist.
  2. Cursor based pagination requires you provide a limit and a cursor parameter. It will return both a hasMore boolean to indicate if more results exist as well as a nextCursor string to use for the next set of records.