All responses to authenticated API requests follow the same structure, wrapping resource data within an
/api/response
object of the following form:
Attribute | Description |
---|---|
_object string | String representing the object’s type. Always /api/response for this object |
self string | The full path to the resource(s) requested |
version integer | The version of the request (see the Versioning docs section) |
data object | The resource data requested for a successful response. null on error |
error object | The error object indicating what went wrong (see the Errors docs section) |
errors list | List of legacy error object JSONs of structure {"code": _, "message": _} |