Articles in this section
Vtiger CRM API Limits
Introduction
This article lists the API limits enforced to ensure every customer gets a stable environment and that shared resources are well protected.
To prevent API abuse, the number of requests is limited per instance. We have set daily, hourly, and minute limits based on the plan you have subscribed to. The daily limits have a rolling expiration of 24 hours. If you exceed the limits, the API will respond with the HTTP Status Code 429.
API Limits as per Editions
The plan-specific per-day, hour, and minute-level request quotas are displayed below:
| Editions | Day Limits | Per User Limits | Hour Limit | Minute Limit | Free Limit |
|---|---|---|---|---|---|
| One Pilot | 0 | 0 | 0 | 0 | 0 |
| One Growth | 24000 | 200 | 1000 | 30 | 3000 |
| One Professional | 72000 | 600 | 4000 | 60 | 6000 |
| One Enterprise | 120000 | 1000 | 5000 | 90 | 6000 |
| One AI | 120000 | 1000 | 5000 | 90 | 6000 |
You can check the edition limits for the Vtiger CRM edition you are using through web service APIs. If you send the name of the feature, Vtiger will return the following information:
- Edition Limit
- Allowed Limit
- Current Limit
Here are a few examples:
- The number of workflows you have used up to the current date.
- The number of webhooks used and the number remaining as per your edition limits.
- The number of runs pending for Server Jobs and Scripts.
Note:
- Requests arriving via REST API/Webservices are considered.
- Mass Retrieve API that retrieves up to 200 records is considered as one request.
- All update, create, and delete requests are single record requests.
Rate Limits
You can make as many API requests as you want, but once you exceed the limit for your edition, calls will return the HTTP status 429.
How do I see my current usage?
Your current rate limit usage is returned in the response headers from each request you make. Consider this example. If the overall API limits are as below:
- HTTP/1.1 200 OK
- X-FloodControl-MinuteLimit: 60
- X-FloodControl-Remaining: 51
- X-FloodControl-Reset:15349121212
- X-RateLimit-DailyLimit: 1200
- X-RateLimit-Remaining: 417
Then each of these parameters is defined as below:
- X-FloodControl-MinuteLimit - The number of requests you are allowed per minute.
- X-FloodControl-Remaining – How many requests can you make before hitting the limit.
- X-FloodControl-Reset – The next time (Unix timestamp), the minute limit is updated.
- X-RateLimit-DailyLimit – The number of requests you are allowed per day.
- X-RateLimit-Remaining – The remaining number of requests allowed for the day.
- X-RateLimit-Reset– The next time (Unix timestamp), the limit will be updated.
- Gmail Add-on
- Mobile
- Extensions