Skip to content

Commit 0c53717

Browse files
authored
docs: api v2 rate limits (calcom#24971)
1 parent e239b67 commit 0c53717

1 file changed

Lines changed: 19 additions & 3 deletions

File tree

docs/api-reference/v2/introduction.mdx

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,37 @@
11
---
2-
title: 'Introduction to API v2'
3-
description: 'Introduction to Cal.com API v2 endpoints'
2+
title: "Introduction to API v2"
3+
description: "Introduction to Cal.com API v2 endpoints"
44
---
55

66
## Platform endpoints
7+
78
Platform customers have the following endpoints available:
89

910
1. Endpoints prefixed with "Platform".
1011
2. Endpoints with no prefix e.g "Bookings", "Event Types".
1112
3. If you are at least on the ESSENTIALS plan, then all endpoints prefixed with "Orgs" except "Orgs / Attributes", "Orgs / Attributes / Options" and "Orgs / Teams / Routing forms / Responses".
1213

1314
## Organizations endpoints
15+
1416
Organizations customers have all the endpoints except the ones prefixed with "Platform" and "Teams" and "Orgs / Orgs" because
1517
children organizations are only allowed in the platform plan right now.
1618

1719
## Teams endpoints
20+
1821
Teams customers have all the endpoints except the ones prefixed with "Platform" and "Orgs".
1922

23+
## Rate limits
24+
25+
There are three authentication methods for the API, and each of them has the following rate limits:
26+
27+
1. API Key - 120 requests per minute. This can be increased to a reasonable amount, such as 200 requests per minute. If you require a higher rate limit, such as 800 requests per minute, it is possible, but it may involve extra charges. To request this, please contact support.
28+
29+
2. Platform OAuth Client Credentials - 500 requests per minute
30+
31+
3. Managed User Access Token - 500 requests per minute
32+
33+
If no authentication method is provided, the default rate limit is 120 requests per minute.
34+
2035
## Authentication
2136

2237
The Cal.com API has 3 authentication methods:
@@ -50,6 +65,7 @@ in your request header.
5065
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
5166

5267
### 2. OAuth client credentials
68+
5369
You need to use OAuth credentials when:
5470

5571
1. Managing managed users [API reference](https://cal.com/docs/api-reference/v2/platform-managed-users/create-a-managed-user)
@@ -67,6 +83,7 @@ OAuth credentials can be accessed in the platform dashboard https://app.cal.com/
6783
After you create a managed user you will receive its access and refresh tokens. The response also includes managed user's id, so we recommend you to add new properties to your users table calAccessToken, calRefreshToken and calManagedUserId to store this information.
6884

6985
You need to use access token when managing managed user's:
86+
7087
1. Schedules [API reference](https://cal.com/docs/api-reference/v2/schedules/create-a-schedule)
7188
2. Event types [API reference](https://cal.com/docs/api-reference/v2/event-types/create-an-event-type)
7289
3. Bookings - some endpoints like creating a booking is public, but some like getting all managed user's bookings require managed user's access token [API reference](https://cal.com/docs/api-reference/v2/bookings/get-all-bookings)
@@ -76,4 +93,3 @@ It is passed as an authorization bearer request header Authorization: Bearer \<a
7693
Validity period: access tokens are valid for 60 minutes and refresh tokens for 1 year, and tokens can be refreshed using the refresh endpoint [API reference](https://cal.com/docs/api-reference/v2/oauth/post-v2oauth-refresh). After refreshing you will receive the new access and refresh tokens that you have to store in your database.
7794

7895
Recovering tokens: if you ever lose managed user's access or refresh tokens, you can force refresh them using the OAuth client credentials and store them in your database [API reference](https://cal.com/docs/api-reference/v2/platform-managed-users/force-refresh-tokens).
79-

0 commit comments

Comments
 (0)