Cloud Engagements API rate limits

The Cloud Engagements API limits request rates to protect service resources and ensure fair use. Access to the Cloud Engagements API is provided by Caseware. Requests are authenticated with a Cloud API token. See Get started with Cloud API for how to obtain one.

Rate limit policy

Limits apply per firm across the service, not per endpoint.

If a client exceeds the allowed rate, the API returns an HTTP 429 Too Many Requests status code. Wait until the rate limit window resets before you retry the request.

Response headers

Responses that pass through the rate limiter include the following headers. Use them to track your remaining request allowance.

Header	Description
`x-ratelimit-limit`	Maximum number of requests allowed during the current window.
`x-ratelimit-remaining`	Number of requests remaining during the current window.
`x-ratelimit-reset`	Number of seconds until the current window resets.

Note: Rate limit values are subject to change. Do not hard code them. Read the response headers and adjust your integration's request rate dynamically.

Handle rate limit errors

Check x-ratelimit-remaining on each response and slow down as it approaches zero.
If you receive a 429 status code, pause requests for the number of seconds in x-ratelimit-reset.
Resume requests after the window resets.

Differences from Cloud API rate limits

The Cloud Engagements API uses a different rate limit service from Cloud API. The two use different response headers, so an integration that calls both must read each set of headers separately. For the Cloud API headers and token bucket behavior, see the rate limit policy section in Get started with Cloud API.