/cal-platform | Type: Application | PCID required: Yes
Tools
cal_platform_api_keys_controller_refresh
Refresh API Key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
apiKeyDaysValid | number | No | — | For how many days is managed organization api key valid. Defaults to 30 days. |
apiKeyNeverExpires | boolean | No | — | If true, organization api key never expires. |
cal_platform_me_controller_get_me
Get my profilecal_platform_me_controller_update_me
Update my profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
avatarUrl | string | No | — | URL of the user’s avatar image |
bio | string | No | — | Bio |
defaultScheduleId | number | No | — | defaultScheduleId |
email | string | No | — | |
locale | string | No | — | locale |
metadata | object | No | — | You 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. |
name | string | No | — | name |
timeFormat | number | No | — | Must be 12 or 24 |
timeZone | string | No | — | timeZone |
weekStart | string | No | — | weekStart |
cal_platform_oauth_client_users_controller_create_user
Create a managed user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
clientId | string | Yes | — | clientId |
avatarUrl | string | No | — | URL of the user’s avatar image |
bio | string | No | — | Bio |
email | string | Yes | — | |
locale | string | No | — | locale |
metadata | object | No | — | You 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. |
name | string | Yes | — | Managed user’s name is used in emails |
timeFormat | number | No | — | Must be a number 12 or 24 |
timeZone | string | No | — | Timezone 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. |
weekStart | string | No | — | weekStart |
cal_platform_oauth_client_users_controller_delete_user
Delete a managed user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
clientId | string | Yes | — | clientId |
userId | number | Yes | — | userId |
cal_platform_oauth_client_users_controller_force_refresh
Force refresh tokens Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | number | Yes | — | userId |
clientId | string | Yes | — | clientId |
cal_platform_oauth_client_users_controller_get_managed_users
Get all managed users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
clientId | string | Yes | — | clientId |
limit | number | No | — | The number of items to return |
offset | number | No | — | The number of items to skip |
emails | any[] | No | — | Filter 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
clientId | string | Yes | — | clientId |
userId | number | Yes | — | userId |
cal_platform_oauth_client_users_controller_update_user
Update a managed user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
clientId | string | Yes | — | clientId |
userId | number | Yes | — | userId |
avatarUrl | string | No | — | URL of the user’s avatar image |
bio | string | No | — | Bio |
defaultScheduleId | number | No | — | defaultScheduleId |
email | string | No | — | |
locale | string | No | — | locale |
metadata | object | No | — | You 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. |
name | string | No | — | name |
timeFormat | number | No | — | Must be 12 or 24 |
timeZone | string | No | — | timeZone |
weekStart | string | No | — | weekStart |
cal_platform_oauth_client_webhooks_controller_create_oauth_client_webhook
Create a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
clientId | string | Yes | — | clientId |
active | boolean | Yes | — | active |
payloadTemplate | string | No | — | The template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information |
secret | string | No | — | secret |
subscriberUrl | string | Yes | — | subscriberUrl |
triggers | any[] | Yes | — | triggers |
version | string | No | — | The version of the webhook |
cal_platform_oauth_client_webhooks_controller_delete_all_oauth_client_webhooks
Delete all webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
clientId | string | Yes | — | clientId |
cal_platform_oauth_client_webhooks_controller_delete_oauth_client_webhook
Delete a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhookId | string | Yes | — | webhookId |
clientId | string | Yes | — | clientId |
cal_platform_oauth_client_webhooks_controller_get_oauth_client_webhook
Get a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhookId | string | Yes | — | webhookId |
clientId | string | Yes | — | clientId |
cal_platform_oauth_client_webhooks_controller_get_oauth_client_webhooks
Get all webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
clientId | string | Yes | — | clientId |
take | number | No | — | Maximum number of items to return |
skip | number | No | — | Number of items to skip |
cal_platform_oauth_client_webhooks_controller_update_oauth_client_webhook
Update a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhookId | string | Yes | — | webhookId |
clientId | string | Yes | — | clientId |
active | boolean | No | — | active |
payloadTemplate | string | No | — | The template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information |
secret | string | No | — | secret |
subscriberUrl | string | No | — | subscriberUrl |
triggers | any[] | No | — | triggers |
version | string | No | — | The version of the webhook |
cal_platform_oauth_clients_controller_create_oauth_client
Create an OAuth client Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
areCalendarEventsEnabled | boolean | No | — | 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. |
areDefaultEventTypesEnabled | boolean | No | — | If 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. |
areEmailsEnabled | boolean | No | — | areEmailsEnabled |
bookingCancelRedirectUri | string | No | — | bookingCancelRedirectUri |
bookingRedirectUri | string | No | — | bookingRedirectUri |
bookingRescheduleRedirectUri | string | No | — | bookingRescheduleRedirectUri |
logo | string | No | — | logo |
name | string | Yes | — | name |
permissions | any[] | Yes | — | Array of permission keys like [“BOOKING_READ”, “BOOKING_WRITE”]. Use [”*”] to grant all permissions. |
redirectUris | any[] | Yes | — | redirectUris |
cal_platform_oauth_clients_controller_delete_oauth_client
Delete an OAuth client Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
clientId | string | Yes | — | clientId |
cal_platform_oauth_clients_controller_get_oauth_client_by_id
Get an OAuth client Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
clientId | string | Yes | — | clientId |
cal_platform_oauth_clients_controller_get_oauth_clients
Get all OAuth clientscal_platform_oauth_clients_controller_update_oauth_client
Update an OAuth client Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
clientId | string | Yes | — | clientId |
areCalendarEventsEnabled | boolean | No | — | 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. |
areDefaultEventTypesEnabled | boolean | No | — | If 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. |
areEmailsEnabled | boolean | No | — | areEmailsEnabled |
bookingCancelRedirectUri | string | No | — | bookingCancelRedirectUri |
bookingRedirectUri | string | No | — | bookingRedirectUri |
bookingRescheduleRedirectUri | string | No | — | bookingRescheduleRedirectUri |
logo | string | No | — | logo |
name | string | No | — | name |
redirectUris | any[] | No | — | redirectUris |
cal_platform_oauth_flow_controller_refresh_tokens
Refresh managed user tokens Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
clientId | string | Yes | — | clientId |
refreshToken | string | Yes | — | Managed user’s refresh token. |
cal_platform_stripe_controller_check
Check Stripe connectioncal_platform_stripe_controller_redirect
Get Stripe connect URLcal_platform_stripe_controller_save
Save Stripe credentials Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
state | string | Yes | — | state |
code | string | Yes | — | code |
cal_platform_webhooks_controller_create_webhook
Create a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
active | boolean | Yes | — | active |
payloadTemplate | string | No | — | The template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information |
secret | string | No | — | secret |
subscriberUrl | string | Yes | — | subscriberUrl |
triggers | any[] | Yes | — | triggers |
version | string | No | — | The version of the webhook |
cal_platform_webhooks_controller_delete_webhook
Delete a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhookId | string | Yes | — | webhookId |
cal_platform_webhooks_controller_get_webhook
Get a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhookId | string | Yes | — | webhookId |
cal_platform_webhooks_controller_get_webhooks
Get all webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
take | number | No | — | Maximum number of items to return |
skip | number | No | — | Number of items to skip |
cal_platform_webhooks_controller_update_webhook
Update a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhookId | string | Yes | — | webhookId |
active | boolean | No | — | active |
payloadTemplate | string | No | — | The template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information |
secret | string | No | — | secret |
subscriberUrl | string | No | — | subscriberUrl |
triggers | any[] | No | — | triggers |
version | string | No | — | The version of the webhook |

