/cal-organizations | Type: Application | PCID required: Yes
Tools
cal_organizations_attributes_controller_create_organization_attribute
Create an attribute Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
enabled | boolean | No | — | enabled |
name | string | Yes | — | name |
options | any[] | Yes | — | options |
slug | string | Yes | — | slug |
type | string | Yes | — | type |
cal_organizations_attributes_controller_delete_organization_attribute
Delete an attribute Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
attributeId | string | Yes | — | attributeId |
cal_organizations_attributes_controller_get_organization_attribute
Get an attribute Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
attributeId | string | Yes | — | attributeId |
cal_organizations_attributes_controller_get_organization_attributes
Get all attributes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
take | number | No | — | Maximum number of items to return |
skip | number | No | — | Number of items to skip |
cal_organizations_attributes_controller_update_organization_attribute
Update an attribute Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
attributeId | string | Yes | — | attributeId |
enabled | boolean | No | — | enabled |
name | string | No | — | name |
slug | string | No | — | slug |
type | string | No | — | type |
cal_organizations_attributes_options_controller_assign_organization_attribute_option_to_user
Assign an attribute to a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
userId | number | Yes | — | userId |
attributeId | string | Yes | — | attributeId |
attributeOptionId | string | No | — | attributeOptionId |
value | string | No | — | value |
cal_organizations_attributes_options_controller_create_organization_attribute_option
Create an attribute option Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
attributeId | string | Yes | — | attributeId |
slug | string | Yes | — | slug |
value | string | Yes | — | value |
cal_organizations_attributes_options_controller_delete_organization_attribute_option
Delete an attribute option Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
attributeId | string | Yes | — | attributeId |
optionId | string | Yes | — | optionId |
cal_organizations_attributes_options_controller_get_organization_attribute_options
Get all attribute options Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
attributeId | string | Yes | — | attributeId |
cal_organizations_attributes_options_controller_unassign_organization_attribute_option_from_user
Unassign an attribute from a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
userId | number | Yes | — | userId |
attributeOptionId | string | Yes | — | attributeOptionId |
cal_organizations_attributes_options_controller_update_organization_attribute_option
Update an attribute option Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
attributeId | string | Yes | — | attributeId |
optionId | string | Yes | — | optionId |
slug | string | No | — | slug |
value | string | No | — | value |
cal_organizations_controller_create_organization
Create an organization within an organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
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. |
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. Values can be strings (up to 500 characters), numbers, or booleans. |
name | string | Yes | — | Name of the organization |
slug | string | No | — | Organization 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
managedOrganizationId | number | Yes | — | managedOrganizationId |
orgId | number | Yes | — | orgId |
cal_organizations_controller_get_organization
Get an organization within an organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
managedOrganizationId | number | Yes | — | managedOrganizationId |
orgId | number | Yes | — | orgId |
cal_organizations_controller_get_organizations
Get all organizations within an organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
take | number | No | — | Maximum number of items to return |
skip | number | No | — | Number of items to skip |
slug | string | No | — | The slug of the managed organization |
metadataKey | string | No | — | The key of the metadata - it is case sensitive so provide exactly as stored. If you provide it then you must also provide metadataValue |
metadataValue | string | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
managedOrganizationId | number | Yes | — | managedOrganizationId |
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. Values can be strings (up to 500 characters), numbers, or booleans. |
name | string | No | — | Name of the organization |
cal_organizations_delegation_credential_controller_create_delegation_credential
Save delegation credentials for your organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
domain | string | Yes | — | domain |
serviceAccountKey | any[] | Yes | — | serviceAccountKey |
workspacePlatformSlug | string | Yes | — | workspacePlatformSlug |
cal_organizations_delegation_credential_controller_update_delegation_credential
Update delegation credentials of your organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
credentialId | string | Yes | — | credentialId |
enabled | boolean | No | — | enabled |
serviceAccountKey | any[] | No | — | serviceAccountKey |
cal_organizations_memberships_controller_create_membership
Create a membership Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
accepted | boolean | No | — | accepted |
disableImpersonation | boolean | No | — | disableImpersonation |
role | string | Yes | — | If you are platform customer then managed users should only have MEMBER role. |
userId | number | Yes | — | userId |
cal_organizations_memberships_controller_delete_membership
Delete a membership Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
membershipId | number | Yes | — | membershipId |
cal_organizations_memberships_controller_get_all_memberships
Get all memberships Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
take | number | No | — | Maximum number of items to return |
skip | number | No | — | Number of items to skip |
cal_organizations_memberships_controller_get_org_membership
Get a membership Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
membershipId | number | Yes | — | membershipId |
cal_organizations_memberships_controller_update_membership
Update a membership Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
membershipId | number | Yes | — | membershipId |
accepted | boolean | No | — | accepted |
disableImpersonation | boolean | No | — | disableImpersonation |
role | string | No | — | role |
cal_organizations_users_controller_create_organization_user
Create a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
appTheme | string | No | — | Application theme |
autoAccept | boolean | No | — | autoAccept |
avatarUrl | string | No | — | Avatar URL |
bio | string | No | — | Bio |
brandColor | string | No | — | Brand color in HEX format |
darkBrandColor | string | No | — | Dark brand color in HEX format |
defaultScheduleId | number | No | — | Default schedule ID |
email | string | Yes | — | User email address |
hideBranding | boolean | No | — | Hide branding |
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. |
organizationRole | string | No | — | organizationRole |
theme | string | No | — | Theme |
timeFormat | number | No | — | Time format |
timeZone | string | No | — | Time zone |
username | string | No | — | Username |
weekday | string | No | — | Preferred weekday |
cal_organizations_users_controller_delete_organization_user
Delete a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
userId | number | Yes | — | userId |
cal_organizations_users_controller_get_organizations_users
Get all users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
take | number | No | — | The number of items to return |
skip | number | No | — | The number of items to skip |
emails | any[] | No | — | The email address or an array of email addresses to filter by |
assignedOptionIds | any[] | No | — | Filter by assigned attribute option ids. ids must be separated by a comma. |
attributeQueryOperator | string | No | — | Query operator used to filter assigned options, AND by default. |
teamIds | any[] | No | — | Filter by teamIds. Team ids must be separated by a comma. |
cal_organizations_users_controller_update_organization_user
Update a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
userId | number | Yes | — | userId |
cal_organizations_users_ooocontroller_create_organization_user_ooo
Create an out-of-office entry for a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | number | Yes | — | userId |
orgId | number | Yes | — | orgId |
end | string | Yes | — | The end date and time of the out of office period in ISO 8601 format in UTC timezone. |
notes | string | No | — | Optional notes for the out of office entry. |
reason | string | No | — | the reason for the out of office entry, if applicable |
start | string | Yes | — | The start date and time of the out of office period in ISO 8601 format in UTC timezone. |
toUserId | number | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
oooId | number | Yes | — | oooId |
userId | number | Yes | — | userId |
orgId | number | Yes | — | orgId |
cal_organizations_users_ooocontroller_get_organization_user_ooo
Get all out-of-office entries for a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | number | Yes | — | userId |
take | number | No | — | Maximum number of items to return |
skip | number | No | — | Number of items to skip |
sortStart | string | No | — | Sort results by their start time in ascending or descending order. |
sortEnd | string | No | — | Sort results by their end time in ascending or descending order. |
orgId | number | Yes | — | orgId |
cal_organizations_users_ooocontroller_get_organization_users_ooo
Get all out-of-office entries for organization users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
take | number | No | — | Maximum number of items to return |
skip | number | No | — | Number of items to skip |
sortStart | string | No | — | Sort results by their start time in ascending or descending order. |
sortEnd | string | No | — | Sort results by their end time in ascending or descending order. |
email | string | No | — | Filter 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | number | Yes | — | userId |
oooId | number | Yes | — | oooId |
orgId | number | Yes | — | orgId |
end | string | No | — | The end date and time of the out of office period in ISO 8601 format in UTC timezone. |
notes | string | No | — | Optional notes for the out of office entry. |
reason | string | No | — | the reason for the out of office entry, if applicable |
start | string | No | — | The start date and time of the out of office period in ISO 8601 format in UTC timezone. |
toUserId | number | No | — | The ID of the user covering for the out of office period, if applicable. |
cal_organizations_webhooks_controller_create_organization_webhook
Create a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
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_organizations_webhooks_controller_delete_webhook
Delete a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhookId | string | Yes | — | webhookId |
orgId | number | Yes | — | orgId |
cal_organizations_webhooks_controller_get_all_organization_webhooks
Get all webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgId | number | Yes | — | orgId |
take | number | No | — | Maximum number of items to return |
skip | number | No | — | Number of items to skip |
cal_organizations_webhooks_controller_get_organization_webhook
Get a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhookId | string | Yes | — | webhookId |
orgId | number | Yes | — | orgId |
cal_organizations_webhooks_controller_update_org_webhook
Update a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhookId | string | Yes | — | webhookId |
orgId | number | Yes | — | orgId |
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 |

