Skip to main content
The Chariow API uses conventional HTTP response codes to indicate success or failure.

HTTP Status Codes

Error Response Format

Every error response carries a message and an errors field. Some errors also include an empty data field.

Common Errors

Unauthorised (401)

Missing Scope (403)

Returned when the API key is valid but lacks a scope the endpoint requires. errors.scopes lists the missing scopes, and the WWW-Authenticate header repeats them:
See Authentication for the scope each endpoint requires.

Validation Error (422)

Not Found (404)

Rate Limited (429)

The response carries a Retry-After header with the number of seconds to wait. See Rate Limits.