Concept
HTTP Status Codes
Our public API follows the HTTP status code standard.
| Code Number | Name | Description |
|---|---|---|
| 200 | Ok | The request was successful and you should get a body in return. |
| 201 | Created | The request was successful and your data was created. |
| 202 | Accepted | The request was successful and your data was accepted. |
| 204 | Deleted | The request was successful and your data was deleted. |
| 400 | Bad Request | The request was unsuccessful. It's expected that it was an error in the request, such as a field that failed validation. |
| 401 | Unauthorized | The request was not authorized to perform an action. |
| 403 | Forbidden | The request might be valid, but the server refused to process it. |
| 404 | Not found | The request was successful, but there was nothing to show. |
| 409 | Conflict | The request conflicts with existing data, for example a value that must be unique is already in use. |
| 422 | Unprocessable Entity | The request was not processed due to a semantic error, for example a body that could not be read. |
| 429 | Too many requests | You have sent too many requests. See Request Throttling for more info |
| 500 | Internal Server Error | The server experienced an unexpected error. |
Error Responses
Errors return a body with an errorCode and a message.
A 401 is the exception: its body has only a message.
When the request fails validation (400, 409 or 422), errors lists each field that failed.
JSON
{
"errorCode": "INVALID_REQUEST",
"message": "Validation Failed",
"errors": [
{
"code": "NotEmptyValidator",
"field": "Name",
"message": "'Name' must not be empty."
}
]
}