API Rate Limits: Optimizing RESTful API Usage
A rate limit is a set of rules that determines how many API calls an organization can make in a specified time period. The API rate limit is determined by the Organization Plan. This article explains how BoldDesk API rate limits work, including plan-based limits, trial account restrictions, rate limit response headers, and how request quotas are calculated. It also covers common questions about rate limit resets, webhook exclusions, and API usage monitoring.
Plan-Based Rate Limiting
The plan-based rate limiting is listed below.
| Plan | Requests per Minute | Requests per Endpoint in Per Minute | Requests per Hour |
|---|---|---|---|
| Scale (legacy) | 100 | Tickets List - 40 Ticket Create - 40 Ticket Update - 40 Contacts List - 40 Contact Create - 40 |
2000 |
| Momentum (legacy) | 300 | Tickets List - 120 Ticket Create - 120 Ticket Update - 120 Contacts List - 120 Contact Create - 120 |
3000 |
| Enterprise and Business (legacy) | 500 | Tickets List - 200 Ticket Create - 200 Ticket Update - 200 Contacts List - 200 Contact Create - 200 |
4000 |
Trial Account Defaults
A trial account has the following default limits:
- 50 requests per minute
- 1000 requests per hour
The following HTTP headers, which are returned in response to any API request, can be used to verify the rate limit status.
Response Header:
x-rate-limit-limit: 1m
x-rate-limit-remaining: 499
x-rate-limit-reset: 2021-03-26T10:27:19.568443Z
| Header Name | Description |
|---|---|
x-rate-limit-limit |
It shows the time period for the rate limit in minutes, as defined by the rate limit rule |
x-rate-limit-remaining |
It displays the number of API requests that remain under the rate limit rule |
x-rate-limit-reset |
It indicates the reset rate limit in the date-time format |
- Webhooks are excluded from the API hourly rate limits. These limits only pertain to requests initiated by you to the BoldDesk REST APIs. Conversely, webhooks are system-initiated outbound calls dispatched from BoldDesk to your endpoint, and therefore, they are not subject to the API rate-limit restrictions.
- BoldDesk API rate limits are enforced using a rolling 60-minute window, not fixed hourly intervals. When the API limit is reached, available capacity is restored gradually as earlier requests fall outside the rolling time window. As a result, the limit does not automatically reset at the start of the next clock hour, and temporary increases to API limits are not currently supported.
Frequently Asked Questions
-
What determines BoldDesk API rate limits?
BoldDesk API rate limits are determined by the Organization plan. -
What are the default API limits for a trial account?
Trial defaults are 50 requests per minute and 1000 requests per hour. -
How can developers check current rate limit usage?
Check the API response headers:x-rate-limit-limit,x-rate-limit-remaining, andx-rate-limit-reset. -
What does
x-rate-limit-remainingrepresent?
x-rate-limit-remainingindicates how many requests are still allowed under the current rate limit rule. -
Do webhooks count toward the BoldDesk hourly API rate limit?
No. Webhooks are excluded from the hourly API limits because webhooks are outbound calls initiated by BoldDesk. -
Does the hourly API limit reset at the top of the hour?
No. The hourly limit uses a rolling 60-minute window, so capacity returns as earlier requests age out of the window. -
Can BoldDesk temporarily increase API limits?
No. Temporary increases to API limits are not currently supported.
