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

Tools

ToolDescription
cal_organizations_attributes_controller_create_organization_attributeCreate an attribute
cal_organizations_attributes_controller_delete_organization_attributeDelete an attribute
cal_organizations_attributes_controller_get_organization_attributeGet an attribute
cal_organizations_attributes_controller_get_organization_attributesGet all attributes
cal_organizations_attributes_controller_update_organization_attributeUpdate an attribute
cal_organizations_attributes_options_controller_assign_organization_attribute_option_to_userAssign an attribute to a user
cal_organizations_attributes_options_controller_create_organization_attribute_optionCreate an attribute option
cal_organizations_attributes_options_controller_delete_organization_attribute_optionDelete an attribute option
cal_organizations_attributes_options_controller_get_organization_attribute_optionsGet all attribute options
cal_organizations_attributes_options_controller_unassign_organization_attribute_option_from_userUnassign an attribute from a user
cal_organizations_attributes_options_controller_update_organization_attribute_optionUpdate an attribute option
cal_organizations_controller_create_organizationCreate an organization within an organization
cal_organizations_controller_delete_organizationDelete an organization within an organization
cal_organizations_controller_get_organizationGet an organization within an organization
cal_organizations_controller_get_organizationsGet all organizations within an organization
cal_organizations_controller_update_organizationUpdate an organization within an organization
cal_organizations_delegation_credential_controller_create_delegation_credentialSave delegation credentials for your organization
cal_organizations_delegation_credential_controller_update_delegation_credentialUpdate delegation credentials of your organization
cal_organizations_memberships_controller_create_membershipCreate a membership
cal_organizations_memberships_controller_delete_membershipDelete a membership
cal_organizations_memberships_controller_get_all_membershipsGet all memberships
cal_organizations_memberships_controller_get_org_membershipGet a membership
cal_organizations_memberships_controller_update_membershipUpdate a membership
cal_organizations_users_controller_create_organization_userCreate a user
cal_organizations_users_controller_delete_organization_userDelete a user
cal_organizations_users_controller_get_organizations_usersGet all users
cal_organizations_users_controller_update_organization_userUpdate a user
cal_organizations_users_ooocontroller_create_organization_user_oooCreate an out-of-office entry for a user
cal_organizations_users_ooocontroller_delete_organization_user_oooDelete an out-of-office entry for a user
cal_organizations_users_ooocontroller_get_organization_user_oooGet all out-of-office entries for a user
cal_organizations_users_ooocontroller_get_organization_users_oooGet all out-of-office entries for organization users
cal_organizations_users_ooocontroller_update_organization_user_oooUpdate an out-of-office entry for a user
cal_organizations_webhooks_controller_create_organization_webhookCreate a webhook
cal_organizations_webhooks_controller_delete_webhookDelete a webhook
cal_organizations_webhooks_controller_get_all_organization_webhooksGet all webhooks
cal_organizations_webhooks_controller_get_organization_webhookGet a webhook
cal_organizations_webhooks_controller_update_org_webhookUpdate a webhook

cal_organizations_attributes_controller_create_organization_attribute

Create an attribute Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
enabledbooleanNoenabled
namestringYesname
optionsany[]Yesoptions
slugstringYesslug
typestringYestype

cal_organizations_attributes_controller_delete_organization_attribute

Delete an attribute Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
attributeIdstringYesattributeId

cal_organizations_attributes_controller_get_organization_attribute

Get an attribute Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
attributeIdstringYesattributeId

cal_organizations_attributes_controller_get_organization_attributes

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

cal_organizations_attributes_controller_update_organization_attribute

Update an attribute Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
attributeIdstringYesattributeId
enabledbooleanNoenabled
namestringNoname
slugstringNoslug
typestringNotype

cal_organizations_attributes_options_controller_assign_organization_attribute_option_to_user

Assign an attribute to a user Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
userIdnumberYesuserId
attributeIdstringYesattributeId
attributeOptionIdstringNoattributeOptionId
valuestringNovalue

cal_organizations_attributes_options_controller_create_organization_attribute_option

Create an attribute option Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
attributeIdstringYesattributeId
slugstringYesslug
valuestringYesvalue

cal_organizations_attributes_options_controller_delete_organization_attribute_option

Delete an attribute option Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
attributeIdstringYesattributeId
optionIdstringYesoptionId

cal_organizations_attributes_options_controller_get_organization_attribute_options

Get all attribute options Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
attributeIdstringYesattributeId

cal_organizations_attributes_options_controller_unassign_organization_attribute_option_from_user

Unassign an attribute from a user Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
userIdnumberYesuserId
attributeOptionIdstringYesattributeOptionId

cal_organizations_attributes_options_controller_update_organization_attribute_option

Update an attribute option Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
attributeIdstringYesattributeId
optionIdstringYesoptionId
slugstringNoslug
valuestringNovalue

cal_organizations_controller_create_organization

Create an organization within an organization Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
apiKeyDaysValidnumberNoFor how many days is managed organization api key valid. Defaults to 30 days.
apiKeyNeverExpiresbooleanNoIf true, organization api key never expires.
metadataobjectNoYou can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters. Values can be strings (up to 500 characters), numbers, or booleans.
namestringYesName of the organization
slugstringNoOrganization slug in kebab-case - if not provided will be generated automatically based on name.

cal_organizations_controller_delete_organization

Delete an organization within an organization Parameters:
ParameterTypeRequiredDefaultDescription
managedOrganizationIdnumberYesmanagedOrganizationId
orgIdnumberYesorgId

cal_organizations_controller_get_organization

Get an organization within an organization Parameters:
ParameterTypeRequiredDefaultDescription
managedOrganizationIdnumberYesmanagedOrganizationId
orgIdnumberYesorgId

cal_organizations_controller_get_organizations

Get all organizations within an organization Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
takenumberNoMaximum number of items to return
skipnumberNoNumber of items to skip
slugstringNoThe slug of the managed organization
metadataKeystringNoThe key of the metadata - it is case sensitive so provide exactly as stored. If you provide it then you must also provide metadataValue
metadataValuestringNoThe value of the metadata - it is case sensitive so provide exactly as stored. If you provide it then you must also provide metadataKey

cal_organizations_controller_update_organization

Update an organization within an organization Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
managedOrganizationIdnumberYesmanagedOrganizationId
metadataobjectNoYou can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters. Values can be strings (up to 500 characters), numbers, or booleans.
namestringNoName of the organization

cal_organizations_delegation_credential_controller_create_delegation_credential

Save delegation credentials for your organization Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
domainstringYesdomain
serviceAccountKeyany[]YesserviceAccountKey
workspacePlatformSlugstringYesworkspacePlatformSlug

cal_organizations_delegation_credential_controller_update_delegation_credential

Update delegation credentials of your organization Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
credentialIdstringYescredentialId
enabledbooleanNoenabled
serviceAccountKeyany[]NoserviceAccountKey

cal_organizations_memberships_controller_create_membership

Create a membership Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
acceptedbooleanNoaccepted
disableImpersonationbooleanNodisableImpersonation
rolestringYesIf you are platform customer then managed users should only have MEMBER role.
userIdnumberYesuserId

cal_organizations_memberships_controller_delete_membership

Delete a membership Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
membershipIdnumberYesmembershipId

cal_organizations_memberships_controller_get_all_memberships

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

cal_organizations_memberships_controller_get_org_membership

Get a membership Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
membershipIdnumberYesmembershipId

cal_organizations_memberships_controller_update_membership

Update a membership Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
membershipIdnumberYesmembershipId
acceptedbooleanNoaccepted
disableImpersonationbooleanNodisableImpersonation
rolestringNorole

cal_organizations_users_controller_create_organization_user

Create a user Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
appThemestringNoApplication theme
autoAcceptbooleanNoautoAccept
avatarUrlstringNoAvatar URL
biostringNoBio
brandColorstringNoBrand color in HEX format
darkBrandColorstringNoDark brand color in HEX format
defaultScheduleIdnumberNoDefault schedule ID
emailstringYesUser email address
hideBrandingbooleanNoHide branding
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.
organizationRolestringNoorganizationRole
themestringNoTheme
timeFormatnumberNoTime format
timeZonestringNoTime zone
usernamestringNoUsername
weekdaystringNoPreferred weekday

cal_organizations_users_controller_delete_organization_user

Delete a user Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
userIdnumberYesuserId

cal_organizations_users_controller_get_organizations_users

Get all users Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
takenumberNoThe number of items to return
skipnumberNoThe number of items to skip
emailsany[]NoThe email address or an array of email addresses to filter by
assignedOptionIdsany[]NoFilter by assigned attribute option ids. ids must be separated by a comma.
attributeQueryOperatorstringNoQuery operator used to filter assigned options, AND by default.
teamIdsany[]NoFilter by teamIds. Team ids must be separated by a comma.

cal_organizations_users_controller_update_organization_user

Update a user Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
userIdnumberYesuserId

cal_organizations_users_ooocontroller_create_organization_user_ooo

Create an out-of-office entry for a user Parameters:
ParameterTypeRequiredDefaultDescription
userIdnumberYesuserId
orgIdnumberYesorgId
endstringYesThe end date and time of the out of office period in ISO 8601 format in UTC timezone.
notesstringNoOptional notes for the out of office entry.
reasonstringNothe reason for the out of office entry, if applicable
startstringYesThe start date and time of the out of office period in ISO 8601 format in UTC timezone.
toUserIdnumberNoThe ID of the user covering for the out of office period, if applicable.

cal_organizations_users_ooocontroller_delete_organization_user_ooo

Delete an out-of-office entry for a user Parameters:
ParameterTypeRequiredDefaultDescription
oooIdnumberYesoooId
userIdnumberYesuserId
orgIdnumberYesorgId

cal_organizations_users_ooocontroller_get_organization_user_ooo

Get all out-of-office entries for a user Parameters:
ParameterTypeRequiredDefaultDescription
userIdnumberYesuserId
takenumberNoMaximum number of items to return
skipnumberNoNumber of items to skip
sortStartstringNoSort results by their start time in ascending or descending order.
sortEndstringNoSort results by their end time in ascending or descending order.
orgIdnumberYesorgId

cal_organizations_users_ooocontroller_get_organization_users_ooo

Get all out-of-office entries for organization users Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
takenumberNoMaximum number of items to return
skipnumberNoNumber of items to skip
sortStartstringNoSort results by their start time in ascending or descending order.
sortEndstringNoSort results by their end time in ascending or descending order.
emailstringNoFilter ooo entries by the user email address. user must be within your organization.

cal_organizations_users_ooocontroller_update_organization_user_ooo

Update an out-of-office entry for a user Parameters:
ParameterTypeRequiredDefaultDescription
userIdnumberYesuserId
oooIdnumberYesoooId
orgIdnumberYesorgId
endstringNoThe end date and time of the out of office period in ISO 8601 format in UTC timezone.
notesstringNoOptional notes for the out of office entry.
reasonstringNothe reason for the out of office entry, if applicable
startstringNoThe start date and time of the out of office period in ISO 8601 format in UTC timezone.
toUserIdnumberNoThe ID of the user covering for the out of office period, if applicable.

cal_organizations_webhooks_controller_create_organization_webhook

Create a webhook Parameters:
ParameterTypeRequiredDefaultDescription
orgIdnumberYesorgId
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_organizations_webhooks_controller_delete_webhook

Delete a webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhookIdstringYeswebhookId
orgIdnumberYesorgId

cal_organizations_webhooks_controller_get_all_organization_webhooks

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

cal_organizations_webhooks_controller_get_organization_webhook

Get a webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhookIdstringYeswebhookId
orgIdnumberYesorgId

cal_organizations_webhooks_controller_update_org_webhook

Update a webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhookIdstringYeswebhookId
orgIdnumberYesorgId
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