You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api-reference/v2/introduction.mdx
+19-3Lines changed: 19 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,22 +1,37 @@
1
1
---
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"
4
4
---
5
5
6
6
## Platform endpoints
7
+
7
8
Platform customers have the following endpoints available:
8
9
9
10
1. Endpoints prefixed with "Platform".
10
11
2. Endpoints with no prefix e.g "Bookings", "Event Types".
11
12
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".
12
13
13
14
## Organizations endpoints
15
+
14
16
Organizations customers have all the endpoints except the ones prefixed with "Platform" and "Teams" and "Orgs / Orgs" because
15
17
children organizations are only allowed in the platform plan right now.
16
18
17
19
## Teams endpoints
20
+
18
21
Teams customers have all the endpoints except the ones prefixed with "Platform" and "Orgs".
19
22
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
+
20
35
## Authentication
21
36
22
37
The Cal.com API has 3 authentication methods:
@@ -50,6 +65,7 @@ in your request header.
50
65
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
@@ -67,6 +83,7 @@ OAuth credentials can be accessed in the platform dashboard https://app.cal.com/
67
83
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.
68
84
69
85
You need to use access token when managing managed user's:
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
76
93
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.
77
94
78
95
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).
0 commit comments