API Limits
Credit System
API calls in Bigin are associated with Credits. The credits are deducted from your Credit Count, based on the type of the API call that you make. Credit deduction is based upon the intensiveness of the performance, and the memory usage of the operations involved in the API calls.
Each API call made will result in a reduction of 1 credit. However, for some APIs, credit reduction would be different. For example, for a "Get Records with cvid API", 3 credits will be reduced for a single API call. Refer the Credit Deduction table below for more details.
Maximum credit limit in a 24-hour window for various editions of Bigin
| Edition | Allowed Credits | Maximum Credits |
|---|---|---|
| Free Edition | 5000 credits | 5000 credits |
| Express/Zoho One/Premier Edition | 50,000 credits + (Number of User licenses x 250) | 100,000 credits |
Note:
For example, in the Express edition, if there are 10 user licenses in an organization, the available credits will be 52,500 (i.e, 50000 + (10 x 250)). However, the maximum limit for this edition will still be 100,000 credits irrespective of the number of user licenses.
For all editions, factors such as concurrency and sub-concurrency are placed to protect the service from overload. This will impact the total number of API calls we process in the 24-hour rolling window.
The credit deduction for some of the API operations are listed below.
| API Call | Number of Credits Deducted |
|---|---|
| Get Users/Roles/Profiles | 1 |
| Get list of Modules | 1 |
| Get Field Meta Data | 1 |
| Get Module Meta Data | 1 |
| Get records with cvid parameter | 3 |
| Insert/Update | 1 credit for every 10 records |
| Bulk Read Initialize | 50 |
| Bulk Write Initialize | 500 |
| All other APIs | 1 |
The Insert/Update API call can be made for a maximum of 100 records, and the Add/Remove Tags to Multiple records API call can be made for a maximum of 500 records. Therefore, the maximum number of credits that can be deducted for these two API calls are 10.
The API call limit has a rolling 24 hours window, from the start of the call.
Concurrency limits for various editions of Bigin
In addition to the above credit system, Bigin also uses a Concurrency system, to calculate API Limits based on the number of concurrent calls made per user per app in Bigin. These concurrency limits specify the maximum number of API calls that can be simultaneously active at a given point of time for a user per app.
Since the API limits are based on the number of simultaneous active calls, there are no time-based API call restrictions in Bigin. You can make any number of API calls in a minute, provided the number of concurrent calls are within the specified limits.
| Edition | Concurrency Limits for a User/App |
|---|---|
| Free | 5 |
| Express/Zoho One/Premier | 10 |
Sub-concurrency limits for various editions
Besides concurrency limits, Bigin also applies sub-concurrency to limit the number of concurrent calls for the following APIs:
Get Records with cvid or sort_by parameters
Insert, Update records (when the record count is greater than 10)
The sub-concurrency limit for the above APIs is 10 for all the Bigin editions, that is, you can either make a maximum of 10 concurrent requests of one of the above APIs, or 10 concurrent requests of the above APIs put together.
Therefore, when a user makes an API request, two concurrency limits are applied—Concurrency (edition-based) and Sub-concurrency (request-based).
When the sub-concurrency limit for any of the two requests is reached, the system throws an error.
The user can, however, continue to make other requests as they still fall under the primary concurrency limit.