Errors

Error response format and API error codes.

Error responses are JSON objects with a code field. message and data are optional.

{
  "code": "UNAUTHORIZED",
  "message": "unauthorized",
  "data": {}
}
CodeHTTP statusDescription
BAD_REQUEST400The request body, query, path parameter, or uploaded data is inv
UNAUTHORIZED401Authentication is missing or invalid.
WORKSPACE_LIMIT_EXCEEDED403The account or workspace has reached a plan limit.
API_TOKEN_SCOPE_INSUFFICIENT403The API token does not include the required scope.
NOT_FOUND404The requested resource does not exist.
PRINT_DATA_TOO_LARGE413The raw ESC/POS payload exceeds the 1 MiB limit.
RATE_LIMIT_EXCEEDED429The client or workspace exceeded a rate limit.
UNKNOWN500An unexpected server error occurred.