Skip to main content

Response formats

A common error response includes success, code, and error.
Some endpoints return a shorter error response.
A successful request may return a success flag.
Depending on the endpoint, the response may instead contain data and error.

HTTP status codes

Example error responses

400 Bad Request

401 Unauthorized

413 Payload Too Large

500 Internal Server Error

Handle failures

  • If a token has expired, call POST /authenticate to get a new one before retrying.
  • If a batch exceeds the endpoint limit, split the data into smaller requests. For example, some operations accept at most 1,000 records per request.
  • Use exponential backoff on retryable errors such as 429 and some 500 responses.