Skip to main content

Errors

The Polaris API uses conventional HTTP status codes. 2xx means success, 4xx means a client error, 5xx means something went wrong on our end.

Most errors are actionable — double-check your token, account ID, and request parameters before reaching out for support.

Error response format​

{
  "type": "authentication_error",
  "message": "Invalid or missing access token."
}

Status codes​

  • 2xx

    Request succeeded.

  • 400 Bad Request

    Missing or invalid parameters. Check the message field for details.

  • 401 Unauthorized

    Invalid or missing Authorization header.

  • 403 Forbidden

    Your token doesn't have access to this resource.

  • 404 Not Found

    The requested resource doesn't exist.

  • 429 Too Many Requests

    Rate limit exceeded. Retry after the Retry-After header value.

  • 5xx Server Error

    Something went wrong on our end. These are rare and automatically monitored.

Error types​

  • authentication_error

    Invalid or missing access token.

  • permission_error

    Your token does not have access to this resource.

  • not_found

    The requested resource does not exist.

  • rate_limit_exceeded

    Too many requests. Slow down and retry after Retry-After seconds.

{
  "type": "account_id_invalid",
  "message": "The account ID provided is not valid.",
  "documentation_url": "https://docs.polaris.revlv.com/errors"
}