JSON API Payload Patterns/Paginated list response

A list payload with page metadata.

Section: Response envelopes

Paginated list response

json
json
{
  "data": [
    { "id": 1, "name": "Ada" },
    { "id": 2, "name": "Linus" }
  ],
  "meta": {
    "page": 1,
    "page_size": 20,
    "total": 250
  }
}
Explanation

A clear `meta` object works well for pagination details.

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 Response envelopes
Single resource response
A simple object response with nested data.
OpenIn sheetjsonsame section
Cursor-based response
Include a cursor token for the next page.
OpenIn sheetjsonsame section
Structured error payload
Return a machine-readable error code and human-readable message.
OpenIn sheetjson2 tag match
Partial update payload
Send only the fields that should change.
OpenIn sheetjson2 tag match
Event-style message payload
A message with event type, timestamp, and nested data.
OpenIn sheetjson1 tag match