Errors

Error responses

Most JSON error responses include an error string and may include a message with additional detail:

{
  "error": "string",
  "message": "string (optional)"
}

Some validation endpoints return an errors array instead:

{
  "errors": ["string"]
}

Some authorization failures return 403 Forbidden with an empty response body. Check the HTTP status code first, then parse the response body when one is present.

Common status codes

400: The request was invalid or malformed.
401: Unauthorized - Missing or invalid authentication.
403: Forbidden - You don’t have permission, required feature access, or remaining quota for the requested operation.
404: Resource not found.
429: Rate limit or account quota exceeded.
500: Unexpected error while processing the request.

Examples

401 Unauthorized

{
  "error": "Unauthorized",
  "message": "Missing or invalid bearer token"
}

400 Bad Request

{
  "error": "property_ids is required and must be a non-empty array"
}

429 Too Many Requests

Request rate limits return rate-limit headers and a plain text body:

HTTP/1.1 429 Too Many Requests
X-RateLimit-Limit: <limit>
X-RateLimit-Reset-After: <window_seconds>
X-RateLimit-Reset: <reset_unix_timestamp>
Retry-After: <seconds_until_retry>
Content-Type: text/plain

You have exceeded the rate limit for this API.

Account quota limits return JSON:

{
  "error": "Trial API quota limit exceeded",
  "quota_limit": 5000,
  "quota_usage": 5001
}

See Rate Limits for details on rate limit headers and retry timing.

Overview

API Reference

Error responses

Common status codes

Examples

401 Unauthorized

400 Bad Request

429 Too Many Requests

​Error responses

​Common status codes

​Examples

​401 Unauthorized

​400 Bad Request

​429 Too Many Requests

Error responses

Common status codes

Examples

401 Unauthorized

400 Bad Request

429 Too Many Requests