Errors
In this guide, we'll look at what happens when something goes wrong with your API requests.
Status codes
Here is a list of the different categories of status codes returned by the API.
- Name
2xx- Description
A 2xx status code indicates a successful response.
- Name
400- Description
Bad request — validation failed or malformed input.
- Name
401- Description
Unauthorized — invalid or missing authentication.
- Name
403- Description
Forbidden — you don't have permission to access this resource.
- Name
404- Description
Not found — the requested resource doesn't exist.
- Name
409- Description
Conflict — resource already exists or state conflict.
- Name
500- Description
Internal server error — something went wrong on our end.
Error response format
When an API request fails, the response will include an error message describing what went wrong.
- Name
statusCode- Type
- integer
- Description
The HTTP status code of the error.
- Name
message- Type
- string
- Description
A human-readable description of the error.
- Name
error- Type
- string
- Description
The error type or category.
Error response
{
"statusCode": 400,
"message": "Validation failed",
"error": "Bad Request"
}