Skip to main content
Server path: /cal-platform | Type: Application | PCID required: Yes

Tools

ToolDescription
cal_platform_api_keys_controller_refreshRefresh API Key
cal_platform_me_controller_get_meGet my profile
cal_platform_me_controller_update_meUpdate my profile
cal_platform_oauth_client_users_controller_create_userCreate a managed user
cal_platform_oauth_client_users_controller_delete_userDelete a managed user
cal_platform_oauth_client_users_controller_force_refreshForce refresh tokens
cal_platform_oauth_client_users_controller_get_managed_usersGet all managed users
cal_platform_oauth_client_users_controller_get_user_by_idGet a managed user
cal_platform_oauth_client_users_controller_update_userUpdate a managed user
cal_platform_oauth_client_webhooks_controller_create_oauth_client_webhookCreate a webhook
cal_platform_oauth_client_webhooks_controller_delete_all_oauth_client_webhooksDelete all webhooks
cal_platform_oauth_client_webhooks_controller_delete_oauth_client_webhookDelete a webhook
cal_platform_oauth_client_webhooks_controller_get_oauth_client_webhookGet a webhook
cal_platform_oauth_client_webhooks_controller_get_oauth_client_webhooksGet all webhooks
cal_platform_oauth_client_webhooks_controller_update_oauth_client_webhookUpdate a webhook
cal_platform_oauth_clients_controller_create_oauth_clientCreate an OAuth client
cal_platform_oauth_clients_controller_delete_oauth_clientDelete an OAuth client
cal_platform_oauth_clients_controller_get_oauth_client_by_idGet an OAuth client
cal_platform_oauth_clients_controller_get_oauth_clientsGet all OAuth clients
cal_platform_oauth_clients_controller_update_oauth_clientUpdate an OAuth client
cal_platform_oauth_flow_controller_refresh_tokensRefresh managed user tokens
cal_platform_stripe_controller_checkCheck Stripe connection
cal_platform_stripe_controller_redirectGet Stripe connect URL
cal_platform_stripe_controller_saveSave Stripe credentials
cal_platform_webhooks_controller_create_webhookCreate a webhook
cal_platform_webhooks_controller_delete_webhookDelete a webhook
cal_platform_webhooks_controller_get_webhookGet a webhook
cal_platform_webhooks_controller_get_webhooksGet all webhooks
cal_platform_webhooks_controller_update_webhookUpdate a webhook

cal_platform_api_keys_controller_refresh

Refresh API Key Parameters:
ParameterTypeRequiredDefaultDescription
apiKeyDaysValidnumberNoFor how many days is managed organization api key valid. Defaults to 30 days.
apiKeyNeverExpiresbooleanNoIf true, organization api key never expires.

cal_platform_me_controller_get_me

Get my profile

cal_platform_me_controller_update_me

Update my profile Parameters:
ParameterTypeRequiredDefaultDescription
avatarUrlstringNoURL of the user’s avatar image
biostringNoBio
defaultScheduleIdnumberNodefaultScheduleId
emailstringNoemail
localestringNolocale
metadataobjectNoYou can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters, and values up to 500 characters.
namestringNoname
timeFormatnumberNoMust be 12 or 24
timeZonestringNotimeZone
weekStartstringNoweekStart

cal_platform_oauth_client_users_controller_create_user

Create a managed user Parameters:
ParameterTypeRequiredDefaultDescription
clientIdstringYesclientId
avatarUrlstringNoURL of the user’s avatar image
biostringNoBio
emailstringYesemail
localestringNolocale
metadataobjectNoYou can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters, and values up to 500 characters.
namestringYesManaged user’s name is used in emails
timeFormatnumberNoMust be a number 12 or 24
timeZonestringNoTimezone is used to create user’s default schedule from Monday to Friday from 9AM to 5PM. If it is not passed then user does not have a default schedule and it must be created manually via the /schedules endpoint. Until the schedule is created, the user can’t access availability atom to set his / her availability nor booked. It will default to Europe/London if not passed.
weekStartstringNoweekStart

cal_platform_oauth_client_users_controller_delete_user

Delete a managed user Parameters:
ParameterTypeRequiredDefaultDescription
clientIdstringYesclientId
userIdnumberYesuserId

cal_platform_oauth_client_users_controller_force_refresh

Force refresh tokens Parameters:
ParameterTypeRequiredDefaultDescription
userIdnumberYesuserId
clientIdstringYesclientId

cal_platform_oauth_client_users_controller_get_managed_users

Get all managed users Parameters:
ParameterTypeRequiredDefaultDescription
clientIdstringYesclientId
limitnumberNoThe number of items to return
offsetnumberNoThe number of items to skip
emailsany[]NoFilter managed users by email. If you want to filter by multiple emails, separate them with a comma.

cal_platform_oauth_client_users_controller_get_user_by_id

Get a managed user Parameters:
ParameterTypeRequiredDefaultDescription
clientIdstringYesclientId
userIdnumberYesuserId

cal_platform_oauth_client_users_controller_update_user

Update a managed user Parameters:
ParameterTypeRequiredDefaultDescription
clientIdstringYesclientId
userIdnumberYesuserId
avatarUrlstringNoURL of the user’s avatar image
biostringNoBio
defaultScheduleIdnumberNodefaultScheduleId
emailstringNoemail
localestringNolocale
metadataobjectNoYou can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters, and values up to 500 characters.
namestringNoname
timeFormatnumberNoMust be 12 or 24
timeZonestringNotimeZone
weekStartstringNoweekStart

cal_platform_oauth_client_webhooks_controller_create_oauth_client_webhook

Create a webhook Parameters:
ParameterTypeRequiredDefaultDescription
clientIdstringYesclientId
activebooleanYesactive
payloadTemplatestringNoThe template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information
secretstringNosecret
subscriberUrlstringYessubscriberUrl
triggersany[]Yestriggers
versionstringNoThe version of the webhook

cal_platform_oauth_client_webhooks_controller_delete_all_oauth_client_webhooks

Delete all webhooks Parameters:
ParameterTypeRequiredDefaultDescription
clientIdstringYesclientId

cal_platform_oauth_client_webhooks_controller_delete_oauth_client_webhook

Delete a webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhookIdstringYeswebhookId
clientIdstringYesclientId

cal_platform_oauth_client_webhooks_controller_get_oauth_client_webhook

Get a webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhookIdstringYeswebhookId
clientIdstringYesclientId

cal_platform_oauth_client_webhooks_controller_get_oauth_client_webhooks

Get all webhooks Parameters:
ParameterTypeRequiredDefaultDescription
clientIdstringYesclientId
takenumberNoMaximum number of items to return
skipnumberNoNumber of items to skip

cal_platform_oauth_client_webhooks_controller_update_oauth_client_webhook

Update a webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhookIdstringYeswebhookId
clientIdstringYesclientId
activebooleanNoactive
payloadTemplatestringNoThe template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information
secretstringNosecret
subscriberUrlstringNosubscriberUrl
triggersany[]Notriggers
versionstringNoThe version of the webhook

cal_platform_oauth_clients_controller_create_oauth_client

Create an OAuth client Parameters:
ParameterTypeRequiredDefaultDescription
areCalendarEventsEnabledbooleanNoIf true and if managed user has calendar connected, calendar events will be created. Disable it if you manually create calendar events. Default to true.
areDefaultEventTypesEnabledbooleanNoIf true, 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. Set this as false if you want to create a managed user and then manually create event types for the user.
areEmailsEnabledbooleanNoareEmailsEnabled
bookingCancelRedirectUristringNobookingCancelRedirectUri
bookingRedirectUristringNobookingRedirectUri
bookingRescheduleRedirectUristringNobookingRescheduleRedirectUri
logostringNologo
namestringYesname
permissionsany[]YesArray of permission keys like [“BOOKING_READ”, “BOOKING_WRITE”]. Use [”*”] to grant all permissions.
redirectUrisany[]YesredirectUris

cal_platform_oauth_clients_controller_delete_oauth_client

Delete an OAuth client Parameters:
ParameterTypeRequiredDefaultDescription
clientIdstringYesclientId

cal_platform_oauth_clients_controller_get_oauth_client_by_id

Get an OAuth client Parameters:
ParameterTypeRequiredDefaultDescription
clientIdstringYesclientId

cal_platform_oauth_clients_controller_get_oauth_clients

Get all OAuth clients

cal_platform_oauth_clients_controller_update_oauth_client

Update an OAuth client Parameters:
ParameterTypeRequiredDefaultDescription
clientIdstringYesclientId
areCalendarEventsEnabledbooleanNoIf true and if managed user has calendar connected, calendar events will be created. Disable it if you manually create calendar events. Default to true.
areDefaultEventTypesEnabledbooleanNoIf true, 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. Set this as false if you want to create a managed user and then manually create event types for the user.
areEmailsEnabledbooleanNoareEmailsEnabled
bookingCancelRedirectUristringNobookingCancelRedirectUri
bookingRedirectUristringNobookingRedirectUri
bookingRescheduleRedirectUristringNobookingRescheduleRedirectUri
logostringNologo
namestringNoname
redirectUrisany[]NoredirectUris

cal_platform_oauth_flow_controller_refresh_tokens

Refresh managed user tokens Parameters:
ParameterTypeRequiredDefaultDescription
clientIdstringYesclientId
refreshTokenstringYesManaged user’s refresh token.

cal_platform_stripe_controller_check

Check Stripe connection

cal_platform_stripe_controller_redirect

Get Stripe connect URL

cal_platform_stripe_controller_save

Save Stripe credentials Parameters:
ParameterTypeRequiredDefaultDescription
statestringYesstate
codestringYescode

cal_platform_webhooks_controller_create_webhook

Create a webhook Parameters:
ParameterTypeRequiredDefaultDescription
activebooleanYesactive
payloadTemplatestringNoThe template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information
secretstringNosecret
subscriberUrlstringYessubscriberUrl
triggersany[]Yestriggers
versionstringNoThe version of the webhook

cal_platform_webhooks_controller_delete_webhook

Delete a webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhookIdstringYeswebhookId

cal_platform_webhooks_controller_get_webhook

Get a webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhookIdstringYeswebhookId

cal_platform_webhooks_controller_get_webhooks

Get all webhooks Parameters:
ParameterTypeRequiredDefaultDescription
takenumberNoMaximum number of items to return
skipnumberNoNumber of items to skip

cal_platform_webhooks_controller_update_webhook

Update a webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhookIdstringYeswebhookId
activebooleanNoactive
payloadTemplatestringNoThe template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information
secretstringNosecret
subscriberUrlstringNosubscriberUrl
triggersany[]Notriggers
versionstringNoThe version of the webhook