Skip to main content
The API uses standard HTTP status codes and returns error responses in a consistent JSON format.

Error Response Format

All error responses follow this structure:
The details field is optional and typically only included for validation errors.

Error Codes

401 Unauthorized

Returned when authentication is required but not provided or invalid.

403 Forbidden

Returned when the authenticated user doesn’t have sufficient permissions to perform the requested action.
Or when the user lacks required abilities:

404 Not Found

Returned when the requested resource doesn’t exist.
Or:

405 Method Not Allowed

Returned when the HTTP method used is not allowed for the requested endpoint.

422 Unprocessable Content

Returned when the request data fails validation.

500 Internal Server Error

Returned when an unexpected server error occurs.

Other HTTP Exceptions

For other HTTP exceptions, the API returns:
The status code will match the HTTP exception status code.