jsonANYjsonapiresponse
json
{
"data": {
"id": "usr_123",
"name": "Ada",
"email": "ada@example.com"
}
}A `data` envelope keeps the top-level shape predictable.
JSON API Payload Patterns
Reusable JSON payload shapes for APIs: envelopes, pagination, errors, metadata, partial updates, and event-style messages.
Export
Copy the compact sheet, download it, or print it.
Download
`D` dense toggle · `C` copy all
Response envelopes
Common shapes for API success and list responses.
jsonANYjsonapipagination
json
{
"data": [
{ "id": 1, "name": "Ada" },
{ "id": 2, "name": "Linus" }
],
"meta": {
"page": 1,
"page_size": 20,
"total": 250
}
}A clear `meta` object works well for pagination details.
jsonANYjsonapicursor
json
{
"data": [
{ "id": "evt_1" },
{ "id": "evt_2" }
],
"meta": {
"next_cursor": "eyJpZCI6ImV2dF8yIn0="
}
}Cursor pagination scales better than offsets for some workloads.
Errors, events, and partial updates
Production-friendly payload patterns beyond the happy path.
jsonANYjsonapierrors
json
{
"error": {
"code": "USER_NOT_FOUND",
"message": "No user exists for the supplied id.",
"details": {
"id": "usr_999"
}
}
}Structured errors are easier to handle consistently across clients.
jsonANYjsonapipatch
json
{
"display_name": "Ada Lovelace",
"timezone": "America/Los_Angeles"
}A patch payload should omit unrelated fields unless the API defines another behavior.
jsonANYjsoneventswebhooks
json
{
"event": "user.created",
"occurred_at": "2026-03-27T17:00:00Z",
"data": {
"id": "usr_123",
"email": "ada@example.com"
}
}A common pattern for webhooks, queues, and audit logs.
More in JSON
JSONL and NDJSON
Newline-delimited JSON patterns for logs, streams, ETL, and large-file processing workflows.
JSON Schema Validation
Practical JSON Schema examples for required fields, types, enums, arrays, nested objects, and validation workflows.
JSON Formatting, Minifying, and Pretty-Printing
Commands and patterns for compact JSON, human-readable formatting, stable sorting, and terminal-friendly inspection.
JSON Validation and Common Errors
How to validate JSON, spot parse failures, repair common mistakes, and debug malformed payloads quickly.
JSON Escaping and Encoding
Escape sequences, Unicode, URLs, embedded JSON strings, and encoding pitfalls when storing or transporting JSON.
JSON Objects and Arrays
Patterns for nested objects, arrays, list items, nullability, and common data-shape decisions in JSON.