Get all OAuth clients

GET /v2/oauth-clients

Try it

Get all OAuth clients

cURL

curl --request GET \
  --url https://api.cal.com/v2/oauth-clients \
  --header 'Authorization: Bearer <token>'

200

{
  "status": "success",
  "data": [
    {
      "id": "clsx38nbl0001vkhlwin9fmt0",
      "name": "MyClient",
      "secret": "secretValue",
      "permissions": [
        "BOOKING_READ",
        "BOOKING_WRITE"
      ],
      "redirectUris": [
        "https://example.com/callback"
      ],
      "organizationId": 1,
      "createdAt": "2024-03-23T08:33:21.851Z",
      "areEmailsEnabled": true,
      "areDefaultEventTypesEnabled": true,
      "areCalendarEventsEnabled": true,
      "logo": "https://example.com/logo.png",
      "bookingRedirectUri": "https://example.com/booking-redirect",
      "bookingCancelRedirectUri": "https://example.com/booking-cancel",
      "bookingRescheduleRedirectUri": "https://example.com/booking-reschedule"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Authorization · string · required

value must be Bearer <token> where <token> is api key prefixed with cal_

Response

200 - application/json

status · enum<string> · required

Available options: success, error

Example:

"success"

data · object[] · required

Show child attributes

data. id · string · required

Example:

"clsx38nbl0001vkhlwin9fmt0"

data. name · string · required

Example:

"MyClient"

data. secret · string · required

Example:

"secretValue"

data. permissions · enum<string>[] · required

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"]

data. redirectUris · string[] · required

Example:

["https://example.com/callback"]

data. organizationId · number · required

Example:

1

data. createdAt · string<date-time> · required

Example:

"2024-03-23T08:33:21.851Z"

data. areEmailsEnabled · boolean · required

Example:

true

data. areDefaultEventTypesEnabled · boolean · required

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

data. areCalendarEventsEnabled · boolean · required

If true and if managed user has calendar connected, calendar events will be created. Disable it if you manually create calendar events. Default to true.

Example:

true

data. logo · object

Example:

"https://example.com/logo.png"

data. bookingRedirectUri · string

Example:

"https://example.com/booking-redirect"

data. bookingCancelRedirectUri · string

Example:

"https://example.com/booking-cancel"

data. bookingRescheduleRedirectUri · string

Example:

"https://example.com/booking-reschedule"