Responses are delivered in JSON, and may have the following fields:
meta
: Response metadata. Always present.status
: Either "ok" or "error" depending on response code.
object
orobjects
: Endpoints that return a single object shall return it
asobject
, while endpoints that return collections shall useobjects
.error
: Error information. Only for error responses.message
: Human-readable reason for error.type
(optional): Button-global slug for the current error condition.details
(optional): Any accessory details for the givenerror.type
.
Some error types may use this to communicate additional information about
the current condition.