Errors

The API uses the following HTTP status codes:

  • 200 - Success.

  • 400 - Validation error (invalid query/body values). See Validation Error Shape below.

  • 401 - Unauthorized (invalid or missing API key)

  • 404 - Resource not found

  • 429 - Rate limit exceeded

  • 500 - Internal server error

Validation Error Shape

For invalid query/body values, the response returns HTTP 400 with this structure:

{
  "errors": [],
  "properties": {
    "fieldName": {
      "errors": ["Validation message"]
    }
  }
}

The top-level errors array is reserved for request-level errors not attributable to a specific field and is empty for typical field-validation failures; per-field messages live under properties.<fieldName>.errors.

Unauthorized Error Messages

Unauthorized responses use an error string. Depending on auth failure mode, clients may see either "Unauthorized" or "Unauthorized!".

Last updated

Was this helpful?