Responses

Updated at:
Copy as MD

Every API request returns a standard HTTP status code. Error responses always include a response body with details.

Successful requests

A successful request returns a 2xx status code. If the request returns data (for example, a query result), the data is included in the response body. The format and content of the response vary by endpoint. For details, see Write data and Query data.

Failed requests

When a request fails, the API returns a JSON object describing the error. Every error response includes an HTTP status code and a response body with the following fields:

FieldTypeRequiredDescriptionExample
codeIntegerYesHTTP status code400
messageStringYesBrief description of the errorMissing required parameter
detailsStringNoAdditional error detailsMissing value: type

Example error response

{
    "error": {
        "code": 400,
        "message": "Missing parameter <code>type</code>"
    }
}