Core concepts

Requests & responses

Successful responses always come back as JSON with a data envelope. Lists also include a meta object with the pagination cursor; single-object responses skip meta. Errors use a separate envelope with a stable machine-readable code.

Response envelopes

response shapes

json

// List response
{ "data": [ ... ], "meta": { "page": 1, "per_page": 25, "total": 42 } }

// Single-object response
{ "data": { "id": "…", "title": "…" } }

// Error response
{ "error": { "code": "not_found", "message": "Campaign not found" } }

Pagination

Pagination is page-based: send ?page=2&per_page=50. Maximum page size is 100. The meta.totalfield is the exact total count so you can stop iterating when you've seen everything.