API Rate Limits
How rate limits are applied to WorkVell API keys, and what to do when you hit one.
【What is a rate limit】
A cap on how many API requests can be made, applied to prevent excessive calls.
【How WorkVell applies rate limits】
Rate limits are set per API key (the default is 120 requests per minute).
They are not fixed by plan. Contact support if you need a different limit.
An API key can also carry an allowlist of source IP addresses, scopes, and an expiry date (see #GEN-044).
【When you hit the limit】
HTTP 429 Too Many Requests is returned.
Wait before retrying.
【Best practices】
(1) Back off — widen the interval between retries progressively
(2) Batch your work — fetch and update data in bulk
(3) Cache responses — do not re-fetch data that rarely changes
【Checking your usage】
There is no API usage screen in the admin console.
Contact support if you need usage figures.
【Obtaining an API key】
API keys cannot be issued from the admin console. Please contact support (see #GEN-008).
Was this article helpful?