API conventions
Filters, pagination, sorting, and error codes
Pagination
Use page and limit. Never assume defaults are unlimited—caps are enforced per resource.
Filters
Many filters accept comma-separated values or repeated query keys. Exact names and types are listed in GET /v1/{resource}/meta.
Sorting
When documented, sort and order follow each resource’s rules; otherwise rely on stable default ordering.
Common error codes
| Code | When |
|---|---|
INVALID_FILTER | Unknown or malformed query parameter |
NOT_FOUND | Missing record |
RATE_LIMIT_EXCEEDED | Too many requests in the window |
See Response format for the error object shape.