Error codes & format

Sending a POST request with a malformed body will return status code 400 and a body in this format:

{
    "errors": [{
        "field": "title",
        "structure": "Required rule",
        "error": "This field is required"
    },
    {
        "field": "content",
        "structure": "Required rule",
        "error": "This field is required"
    }]
}

Another common error that affects both POST and GET requests is the 404 error when a resource cannot be found. In this case, the server will return the status code 404 and a body like the one below:

{
    "message": "Not found."
}

If an IP address sends more than 100 requests in 1 minute, we may return an error with status code 429. Please get in touch with us if you would like to increase this limit. The response body will be as shown below:

{
    "message": "Too Many Attempts."
}

The same error status code 429 is returned if the account quota is exceeded, in which case the response body is as follows:

{
    "message": "Quota exceeded."
}

Less common errors are those with status code 403, which indicates that an operation is not authorised. Note that for security reasons and to prevent data being leaked to unauthorised parties, error 404 is often returned when an operation is not authorised (e.g. accessing a project without an invitation).

{
    "message": "This action is unauthorized."
}

Last updated