Getting Started
Platform / Cal Provider
Platform / Managed Users
Platform / Webhooks
Orgs / Attributes
Orgs / Attributes / Options
Orgs / Event Types
Orgs / Memberships
Orgs / Orgs
Orgs / Schedules
Orgs / Teams
Orgs / Teams / Bookings
Orgs / Teams / Memberships
Orgs / Teams / Routing forms / Responses
Orgs / Teams / Schedules
Orgs / Users / OOO
Orgs / Webhooks
Api Keys
Bookings
- GETGet all bookings
- POSTCreate a booking
- GETGet a booking
- POSTReschedule a booking
- POSTCancel a booking
- POSTMark a booking absence
- POSTAutomatically reassign booking to a new host
- POSTReassign a booking to a specific user
- POSTConfirm booking that requires a confirmation
- POSTDecline booking that requires a confirmation
Calendars
Conferencing
Destination Calendars
Event Types
Event Types / Webhooks
OAuth Clients
Schedules
Selected Calendars
Slots
Stripe
Teams / Event Types
Teams / Memberships
Timezones
Get v2oauth clients 1
⚠️ First, this endpoint requires Cookie: next-auth.session-token=eyJhbGciOiJ
header. Log into Cal web app using owner of organization that was created after visiting /settings/organizations/new
, refresh swagger docs, and the cookie will be added to requests automatically to pass the NextAuthGuard.
Second, make sure that the logged in user has organizationId set to pass the OrganizationRolesGuard guard.
curl --request GET \
--url https://api.cal.com/v2/oauth-clients/{clientId}
{
"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"
}
}
Path Parameters
Response
success
, error
Array of permission keys like ["BOOKING_READ", "BOOKING_WRITE"]
EVENT_TYPE_READ
, EVENT_TYPE_WRITE
, BOOKING_READ
, BOOKING_WRITE
, SCHEDULE_READ
, SCHEDULE_WRITE
, APPS_READ
, APPS_WRITE
, PROFILE_READ
, PROFILE_WRITE
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.
Was this page helpful?
curl --request GET \
--url https://api.cal.com/v2/oauth-clients/{clientId}
{
"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"
}
}