OAuth Clients
Get all OAuth clients
Getting Started
Platform / Managed Users
Platform / Webhooks
Orgs / Attributes
Orgs / Attributes / Options
- GETGet all attribute options
- POSTCreate an attribute option
- DELDelete an attribute option
- PATCHUpdate an attribute option
- GETGet by attribute id all of the attribute options that are assigned to users
- GETGet by attribute slug all of the attribute options that are assigned to users
- GETGet all attribute options for a user
- POSTAssign an attribute to a user
- DELUnassign an attribute from a user
Orgs / Bookings
Orgs / Delegation Credentials
Orgs / Memberships
Orgs / Routing forms
Orgs / Schedules
Orgs / Teams
Orgs / Teams / Bookings
Orgs / Teams / Conferencing
- POSTConnect your conferencing application to a team
- GETGet OAuth conferencing app's auth url for a team
- GETList team conferencing applications
- POSTSet team default conferencing application
- GETGet team default conferencing application
- DELDisconnect team conferencing application
- GETSave conferencing app OAuth credentials
Orgs / Teams / Event Types
Orgs / Teams / Memberships
Orgs / Teams / Routing forms
Orgs / Teams / Routing forms / Responses
Orgs / Teams / Users / Schedules
Orgs / Users / Bookings
Orgs / Users / OOO
Orgs / Users / Schedules
Orgs / Webhooks
Api Keys
Bookings
Calendars
Conferencing
Destination Calendars
Event Types
Event Types / Webhooks
Managed Orgs
OAuth Clients
Organizations/Teams Stripe
Routing forms
Schedules
Selected Calendars
Slots
Teams / Event Types
Teams / Memberships
OAuth Clients
Get all OAuth clients
GET
/
v2
/
oauth-clients
curl --request GET \
--url https://api.cal.com/v2/oauth-clients \
--header 'Authorization: <authorization>'
{
"status": "success",
"data": [
{
"id": "clsx38nbl0001vkhlwin9fmt0",
"name": "MyClient",
"secret": "secretValue",
"permissions": [
"BOOKING_READ",
"BOOKING_WRITE"
],
"logo": "https://example.com/logo.png",
"redirectUris": [
"https://example.com/callback"
],
"organizationId": 1,
"createdAt": "2024-03-23T08:33:21.851Z",
"areEmailsEnabled": true,
"areDefaultEventTypesEnabled": true,
"bookingRedirectUri": "https://example.com/booking-redirect",
"bookingCancelRedirectUri": "https://example.com/booking-cancel",
"bookingRescheduleRedirectUri": "https://example.com/booking-reschedule"
}
]
}
Headers
value must be Bearer <token>
where <token>
is api key prefixed with cal_
Response
200 - application/json
Available options:
success
, error
Example:
"success"
Example:
"clsx38nbl0001vkhlwin9fmt0"
Example:
"MyClient"
Example:
"secretValue"
Array of permission keys like ["BOOKING_READ", "BOOKING_WRITE"]
Available options:
EVENT_TYPE_READ
, EVENT_TYPE_WRITE
, BOOKING_READ
, BOOKING_WRITE
, SCHEDULE_READ
, SCHEDULE_WRITE
, APPS_READ
, APPS_WRITE
, PROFILE_READ
, PROFILE_WRITE
Example:
["BOOKING_READ", "BOOKING_WRITE"]
Example:
["https://example.com/callback"]
Example:
1
Example:
"2024-03-23T08:33:21.851Z"
Example:
true
If enabled, when creating a managed user the managed user will have 4 default event types: 30 and 60 minutes without Cal video, 30 and 60 minutes with Cal video. Leave this disabled if you want to create a managed user and then manually create event types for the user.
Example:
true
Example:
"https://example.com/logo.png"
Example:
"https://example.com/booking-redirect"
Example:
"https://example.com/booking-cancel"
Example:
"https://example.com/booking-reschedule"
Was this page helpful?
curl --request GET \
--url https://api.cal.com/v2/oauth-clients \
--header 'Authorization: <authorization>'
{
"status": "success",
"data": [
{
"id": "clsx38nbl0001vkhlwin9fmt0",
"name": "MyClient",
"secret": "secretValue",
"permissions": [
"BOOKING_READ",
"BOOKING_WRITE"
],
"logo": "https://example.com/logo.png",
"redirectUris": [
"https://example.com/callback"
],
"organizationId": 1,
"createdAt": "2024-03-23T08:33:21.851Z",
"areEmailsEnabled": true,
"areDefaultEventTypesEnabled": true,
"bookingRedirectUri": "https://example.com/booking-redirect",
"bookingCancelRedirectUri": "https://example.com/booking-cancel",
"bookingRescheduleRedirectUri": "https://example.com/booking-reschedule"
}
]
}