Response

All responses are in JSON objects. Appropriate HTTP status codes are sent for each response.

Success

Success Each REST API request returns a success or error HTTP status code. Successful responses all have HTTP status codes with a value of 200 with the exception of entity creation endpoints which have a value of 201. All success responses has an object called .

Sample Success Response

{
    "data": {
        ...
    }
}

Error

Error In the responses for failed requests, we return HTTP 400 status code. They are usually returned in this format with the HTTP 400 status code:

{
    "error": "error type",
    "message": "Error message"
}