Responses

Content-Type Header

All responses are returned in JSON format. We specify this by sending the Content-Type header.

Status Codes

Below is a table containing descriptions of the various status codes we currently support against various resources.

Response Code	Description
200	OK / Partial Success
201	Resource Created
202	Accepted
400	Bad Request / Validation Error
401	Unauthorized
403	Forbidden
404	Resource Not Found
405	Method Not Allowed
406	Not Acceptable
422	Unprocessable Entity
429	Too Many Requests
500	Internal Server Error

Pagination

When a request is made with a pagination query, the meta data is included in the response to allow for easy traversal of previous, current, first, and last page of the data set.

{
    "data": [
        // Response data 
    ],
    "meta": {
        "total_pages": 100,
        "total_rows": 2000,
        "order": "DESC",
        "order_by": "resource_field",
        "limit": 20,
        "offset": 0,
        "next_key": ""
    }
}