Expose pagination state in the response body.

Section: Pagination patterns

Return next-page metadata

json
json
{
  "data": [/* ... */],
  "page": 2,
  "limit": 25,
  "total": 140,
  "next_cursor": null
}
Explanation

Pagination metadata helps clients build pagers and infinite-scroll experiences without guessing.

Learn the surrounding workflow

Compare similar commands or jump into common fixes when this command is part of a bigger troubleshooting path.

Related commands

Same sheet · prioritizing Pagination patterns
Offset pagination
Simple page and limit contract.
OpenIn sheethttpsame section
Cursor pagination
Use opaque cursors for large or changing datasets.
OpenIn sheethttpsame section
Use a stable sort key with cursors
Paginate in a deterministic order.
OpenIn sheethttpsame section
Filter by exact field values
Restrict a collection by one or more fields.
OpenIn sheethttp1 tag match
Sort descending by one field
Ask for newest records first.
OpenIn sheethttp1 tag match
Sort by multiple fields
Provide fallback ordering.
OpenIn sheethttp1 tag match