Data
Contains the requested data from the endpoint and can be either a JSON list or a JSON object.- Every top level object or item in an array will contain a
type
field indicating the entity type. data
will only be present if the result is successful, in which case there will be a2**
status code and noerror
field.
Errors
An array oferror
objects. error
objects will contain the following fields.
type
: One of a fixed set of categories. Helpful for categorizing & processing errorsdescription
: A human readable error description.meta
: Optional additional information.errors
will be present only if the request is unsuccessful, in which case there will be a4**
or5**
status code and nodata
field.
Meta
An optional object that may be used to communicate metadata about the request. Example use cases include:- Idempotency
- Pagination
- Rate limits