Response

When a request is successful, a response body will typically be sent back in the form of a JSON object.

One exception is the DELETE request, which will result in a successful HTTP 204 status and an empty response body.

Another exception is when a request is processed asynchronously, it will result in a successful HTTP 202 status and an empty response body.


Collection

A collection of resources will be displayed within the data object.

{
    "data": [
        {
            "id": 1,
            "is_test": true,
            "first_name": "John",
            "last_name": "Doe",
            "company": null,
            "addresses": [],
            "created_at": "2017-09-28T08:40:44+00:00",
            "updated_at": "2017-09-28T08:40:44+00:00",
            ....
        }
    ]
}

Resource

A resource are presented directly.

{
  "id": 1,
  "is_test": true,
  "first_name": "John",
  "last_name": "Doe",
  "company": null,
  "addresses": [],
  "created_at": "2017-09-28T08:40:44+00:00",
  "updated_at": "2017-09-28T08:40:44+00:00",
  ...
}

Attribute

If an attribute has no value it is presented as null. If an attribute is some kind of list and it is represented by an array, an array will be returned, even if empty.

{
  "company": null,
  "addresses": [],
  ...
}

Timestamp

All time values presented in ISO8601 format: YYYYY-MM-DDTHH:MM:SSZ.