errors

Errors

We use conventional HTTP status codes to indicate success or failure. In general:

• 2xx: Success
• 4xx: Request errors (fix the request)
• 5xx: Server errors (retry with backoff; include requestId when contacting support)

Error responses share a consistent structure across all endpoints.

Error object (attributes)

status integer

HTTP status code (e.g., 400, 422, 500).

---

title string

Short, human-readable summary (e.g., "Validation failed").

---

code string

Stable, machine-readable error code (e.g., validation_failed, unauthorized).

---

detail string

Human-readable explanation that may include parameter-level context.

---

source nullable object

Where the error originated (optional).

• parameter nullable string - Name of the request parameter with an issue.
• pointer nullable string - JSON Pointer path (e.g., /data/attributes/email) when applicable.

---

HTTP status code summary

A general overview of HTTP status codes used throughout the API.

Code	Status	Description
400	Bad Request	The request was unacceptable due to validation failures or malformed data. Validate request schema, types, and formats; remove unsupported fields; resend corrected request.
401	Unauthorized	No valid authentication credentials provided. Provide valid credentials (Bearer token/API key); refresh/rotate if expired or revoked.
403	Forbidden	The authenticated user lacks required permissions. Use an account/role with required permissions or request appropriate scopes.
404	Not Found	The requested resource doesn't exist. Verify the resource ID and path; ensure the resource exists and is accessible.
422	Unprocessable Entity	The request was well-formed but contains invalid data. Fix invalid fields; follow messages in detail/source; re-submit only after corrections.
500	Internal Server Error	Something went wrong on our end. Retry with backoff; contact support if it persists.