cal-organizations

Cal.com Organizations - manage orgs, attributes, memberships, users, and webhooks

Server path: /cal-organizations | Type: Application | PCID required: Yes

Tools

Tool	Description
cal_organizations_attributes_controller_create_organization_attribute	Create an attribute
cal_organizations_attributes_controller_delete_organization_attribute	Delete an attribute
cal_organizations_attributes_controller_get_organization_attribute	Get an attribute
cal_organizations_attributes_controller_get_organization_attributes	Get all attributes
cal_organizations_attributes_controller_update_organization_attribute	Update an attribute
cal_organizations_attributes_options_controller_assign_organization_attribute_option_to_user	Assign an attribute to a user
cal_organizations_attributes_options_controller_create_organization_attribute_option	Create an attribute option
cal_organizations_attributes_options_controller_delete_organization_attribute_option	Delete an attribute option
cal_organizations_attributes_options_controller_get_organization_attribute_options	Get all attribute options
cal_organizations_attributes_options_controller_unassign_organization_attribute_option_from_user	Unassign an attribute from a user
cal_organizations_attributes_options_controller_update_organization_attribute_option	Update an attribute option
cal_organizations_controller_create_organization	Create an organization within an organization
cal_organizations_controller_delete_organization	Delete an organization within an organization
cal_organizations_controller_get_organization	Get an organization within an organization
cal_organizations_controller_get_organizations	Get all organizations within an organization
cal_organizations_controller_update_organization	Update an organization within an organization
cal_organizations_delegation_credential_controller_create_delegation_credential	Save delegation credentials for your organization
cal_organizations_delegation_credential_controller_update_delegation_credential	Update delegation credentials of your organization
cal_organizations_memberships_controller_create_membership	Create a membership
cal_organizations_memberships_controller_delete_membership	Delete a membership
cal_organizations_memberships_controller_get_all_memberships	Get all memberships
cal_organizations_memberships_controller_get_org_membership	Get a membership
cal_organizations_memberships_controller_update_membership	Update a membership
cal_organizations_users_controller_create_organization_user	Create a user
cal_organizations_users_controller_delete_organization_user	Delete a user
cal_organizations_users_controller_get_organizations_users	Get all users
cal_organizations_users_controller_update_organization_user	Update a user
cal_organizations_users_ooocontroller_create_organization_user_ooo	Create an out-of-office entry for a user
cal_organizations_users_ooocontroller_delete_organization_user_ooo	Delete an out-of-office entry for a user
cal_organizations_users_ooocontroller_get_organization_user_ooo	Get all out-of-office entries for a user
cal_organizations_users_ooocontroller_get_organization_users_ooo	Get all out-of-office entries for organization users
cal_organizations_users_ooocontroller_update_organization_user_ooo	Update an out-of-office entry for a user
cal_organizations_webhooks_controller_create_organization_webhook	Create a webhook
cal_organizations_webhooks_controller_delete_webhook	Delete a webhook
cal_organizations_webhooks_controller_get_all_organization_webhooks	Get all webhooks
cal_organizations_webhooks_controller_get_organization_webhook	Get a webhook
cal_organizations_webhooks_controller_update_org_webhook	Update a webhook

---

cal_organizations_attributes_controller_create_organization_attribute

Create an attribute

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
enabled	boolean	No	—	The enabled value
name	string	Yes	—	The name value
options	object[]	Yes	—	The options value
slug	string	Yes	—	The slug value
type	string	Yes	—	The type value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "enabled": {
      "type": "boolean",
      "description": "The enabled value"
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "options": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "value": {
            "type": "string",
            "description": "The value value"
          },
          "slug": {
            "type": "string",
            "description": "The slug value"
          }
        },
        "required": [
          "value",
          "slug"
        ]
      },
      "description": "The options value"
    },
    "slug": {
      "type": "string",
      "description": "The slug value"
    },
    "type": {
      "type": "string",
      "description": "The type value",
      "enum": [
        "TEXT",
        "NUMBER",
        "SINGLE_SELECT",
        "MULTI_SELECT"
      ]
    }
  },
  "required": [
    "PCID",
    "orgId",
    "name",
    "options",
    "slug",
    "type"
  ]
}

---

cal_organizations_attributes_controller_delete_organization_attribute

Delete an attribute

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
attributeId	string	Yes	—	Attribute Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "attributeId": {
      "type": "string",
      "description": "Attribute Id"
    }
  },
  "required": [
    "PCID",
    "orgId",
    "attributeId"
  ]
}

---

cal_organizations_attributes_controller_get_organization_attribute

Get an attribute

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
attributeId	string	Yes	—	Attribute Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "attributeId": {
      "type": "string",
      "description": "Attribute Id"
    }
  },
  "required": [
    "PCID",
    "orgId",
    "attributeId"
  ]
}

---

cal_organizations_attributes_controller_get_organization_attributes

Get all attributes

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
take	number	No	—	Maximum number of items to return
skip	number	No	—	Number of items to skip

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "take": {
      "type": "number",
      "description": "Maximum number of items to return"
    },
    "skip": {
      "type": "number",
      "description": "Number of items to skip"
    }
  },
  "required": [
    "PCID",
    "orgId"
  ]
}

---

cal_organizations_attributes_controller_update_organization_attribute

Update an attribute

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
attributeId	string	Yes	—	Attribute Id
enabled	boolean	No	—	The enabled value
name	string	No	—	The name value
slug	string	No	—	The slug value
type	string	No	—	The type value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "attributeId": {
      "type": "string",
      "description": "Attribute Id"
    },
    "enabled": {
      "type": "boolean",
      "description": "The enabled value"
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "slug": {
      "type": "string",
      "description": "The slug value"
    },
    "type": {
      "type": "string",
      "description": "The type value",
      "enum": [
        "TEXT",
        "NUMBER",
        "SINGLE_SELECT",
        "MULTI_SELECT"
      ]
    }
  },
  "required": [
    "PCID",
    "orgId",
    "attributeId"
  ]
}

---

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	—	Org Id
userId	number	Yes	—	User Id
attributeId	string	Yes	—	Attribute Id
attributeOptionId	string	No	—	Attribute Option Id
value	string	No	—	The value value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "userId": {
      "type": "number",
      "description": "User Id"
    },
    "attributeId": {
      "type": "string",
      "description": "Attribute Id"
    },
    "attributeOptionId": {
      "type": "string",
      "description": "Attribute Option Id"
    },
    "value": {
      "type": "string",
      "description": "The value value"
    }
  },
  "required": [
    "PCID",
    "orgId",
    "userId",
    "attributeId"
  ]
}

---

cal_organizations_attributes_options_controller_create_organization_attribute_option

Create an attribute option

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
attributeId	string	Yes	—	Attribute Id
slug	string	Yes	—	The slug value
value	string	Yes	—	The value value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "attributeId": {
      "type": "string",
      "description": "Attribute Id"
    },
    "slug": {
      "type": "string",
      "description": "The slug value"
    },
    "value": {
      "type": "string",
      "description": "The value value"
    }
  },
  "required": [
    "PCID",
    "orgId",
    "attributeId",
    "slug",
    "value"
  ]
}

---

cal_organizations_attributes_options_controller_delete_organization_attribute_option

Delete an attribute option

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
attributeId	string	Yes	—	Attribute Id
optionId	string	Yes	—	Option Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "attributeId": {
      "type": "string",
      "description": "Attribute Id"
    },
    "optionId": {
      "type": "string",
      "description": "Option Id"
    }
  },
  "required": [
    "PCID",
    "orgId",
    "attributeId",
    "optionId"
  ]
}

---

cal_organizations_attributes_options_controller_get_organization_attribute_options

Get all attribute options

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
attributeId	string	Yes	—	Attribute Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "attributeId": {
      "type": "string",
      "description": "Attribute Id"
    }
  },
  "required": [
    "PCID",
    "orgId",
    "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	—	Org Id
userId	number	Yes	—	User Id
attributeOptionId	string	Yes	—	Attribute Option Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "userId": {
      "type": "number",
      "description": "User Id"
    },
    "attributeOptionId": {
      "type": "string",
      "description": "Attribute Option Id"
    }
  },
  "required": [
    "PCID",
    "orgId",
    "userId",
    "attributeOptionId"
  ]
}

---

cal_organizations_attributes_options_controller_update_organization_attribute_option

Update an attribute option

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
attributeId	string	Yes	—	Attribute Id
optionId	string	Yes	—	Option Id
slug	string	No	—	The slug value
value	string	No	—	The value value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "attributeId": {
      "type": "string",
      "description": "Attribute Id"
    },
    "optionId": {
      "type": "string",
      "description": "Option Id"
    },
    "slug": {
      "type": "string",
      "description": "The slug value"
    },
    "value": {
      "type": "string",
      "description": "The value value"
    }
  },
  "required": [
    "PCID",
    "orgId",
    "attributeId",
    "optionId"
  ]
}

---

cal_organizations_controller_create_organization

Create an organization within an organization

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "apiKeyDaysValid": {
      "type": "number",
      "description": "For how many days is managed organization api key valid. Defaults to 30 days."
    },
    "apiKeyNeverExpires": {
      "type": "boolean",
      "description": "If true, organization api key never expires."
    },
    "metadata": {
      "type": "object",
      "description": "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": {
      "type": "string",
      "description": "Name of the organization"
    },
    "slug": {
      "type": "string",
      "description": "Organization slug in kebab-case - if not provided will be generated automatically based on name."
    }
  },
  "required": [
    "PCID",
    "orgId",
    "name"
  ]
}

---

cal_organizations_controller_delete_organization

Delete an organization within an organization

Parameters:

Parameter	Type	Required	Default	Description
managedOrganizationId	number	Yes	—	Managed Organization Id
orgId	number	Yes	—	Org Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "managedOrganizationId": {
      "type": "number",
      "description": "Managed Organization Id"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    }
  },
  "required": [
    "PCID",
    "managedOrganizationId",
    "orgId"
  ]
}

---

cal_organizations_controller_get_organization

Get an organization within an organization

Parameters:

Parameter	Type	Required	Default	Description
managedOrganizationId	number	Yes	—	Managed Organization Id
orgId	number	Yes	—	Org Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "managedOrganizationId": {
      "type": "number",
      "description": "Managed Organization Id"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    }
  },
  "required": [
    "PCID",
    "managedOrganizationId",
    "orgId"
  ]
}

---

cal_organizations_controller_get_organizations

Get all organizations within an organization

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "take": {
      "type": "number",
      "description": "Maximum number of items to return"
    },
    "skip": {
      "type": "number",
      "description": "Number of items to skip"
    },
    "slug": {
      "type": "string",
      "description": "The slug of the managed organization"
    },
    "metadataKey": {
      "type": "string",
      "description": "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": {
      "type": "string",
      "description": "The value of the metadata - it is case sensitive so provide exactly as stored. If you provide it then you must also provide metadataKey"
    }
  },
  "required": [
    "PCID",
    "orgId"
  ]
}

---

cal_organizations_controller_update_organization

Update an organization within an organization

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
managedOrganizationId	number	Yes	—	Managed Organization Id
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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "managedOrganizationId": {
      "type": "number",
      "description": "Managed Organization Id"
    },
    "metadata": {
      "type": "object",
      "description": "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": {
      "type": "string",
      "description": "Name of the organization"
    }
  },
  "required": [
    "PCID",
    "orgId",
    "managedOrganizationId"
  ]
}

---

cal_organizations_delegation_credential_controller_create_delegation_credential

Save delegation credentials for your organization

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
domain	string	Yes	—	The domain value
serviceAccountKey	any[]	Yes	—	Service Account Key
workspacePlatformSlug	string	Yes	—	Workspace Platform Slug

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "domain": {
      "type": "string",
      "description": "The domain value"
    },
    "serviceAccountKey": {
      "type": "array",
      "description": "Service Account Key"
    },
    "workspacePlatformSlug": {
      "type": "string",
      "description": "Workspace Platform Slug"
    }
  },
  "required": [
    "PCID",
    "orgId",
    "domain",
    "serviceAccountKey",
    "workspacePlatformSlug"
  ]
}

---

cal_organizations_delegation_credential_controller_update_delegation_credential

Update delegation credentials of your organization

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
credentialId	string	Yes	—	Credential Id
enabled	boolean	No	—	The enabled value
serviceAccountKey	any[]	No	—	Service Account Key

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "credentialId": {
      "type": "string",
      "description": "Credential Id"
    },
    "enabled": {
      "type": "boolean",
      "description": "The enabled value"
    },
    "serviceAccountKey": {
      "type": "array",
      "description": "Service Account Key"
    }
  },
  "required": [
    "PCID",
    "orgId",
    "credentialId"
  ]
}

---

cal_organizations_memberships_controller_create_membership

Create a membership

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
accepted	boolean	No	—	The accepted value
disableImpersonation	boolean	No	—	Disable Impersonation
role	string	Yes	—	If you are platform customer then managed users should only have MEMBER role.
userId	number	Yes	—	User Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "accepted": {
      "type": "boolean",
      "description": "The accepted value"
    },
    "disableImpersonation": {
      "type": "boolean",
      "description": "Disable Impersonation"
    },
    "role": {
      "type": "string",
      "description": "If you are platform customer then managed users should only have MEMBER role.",
      "enum": [
        "MEMBER",
        "OWNER",
        "ADMIN"
      ]
    },
    "userId": {
      "type": "number",
      "description": "User Id"
    }
  },
  "required": [
    "PCID",
    "orgId",
    "role",
    "userId"
  ]
}

---

cal_organizations_memberships_controller_delete_membership

Delete a membership

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
membershipId	number	Yes	—	Membership Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "membershipId": {
      "type": "number",
      "description": "Membership Id"
    }
  },
  "required": [
    "PCID",
    "orgId",
    "membershipId"
  ]
}

---

cal_organizations_memberships_controller_get_all_memberships

Get all memberships

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
take	number	No	—	Maximum number of items to return
skip	number	No	—	Number of items to skip

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "take": {
      "type": "number",
      "description": "Maximum number of items to return"
    },
    "skip": {
      "type": "number",
      "description": "Number of items to skip"
    }
  },
  "required": [
    "PCID",
    "orgId"
  ]
}

---

cal_organizations_memberships_controller_get_org_membership

Get a membership

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
membershipId	number	Yes	—	Membership Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "membershipId": {
      "type": "number",
      "description": "Membership Id"
    }
  },
  "required": [
    "PCID",
    "orgId",
    "membershipId"
  ]
}

---

cal_organizations_memberships_controller_update_membership

Update a membership

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
membershipId	number	Yes	—	Membership Id
accepted	boolean	No	—	The accepted value
disableImpersonation	boolean	No	—	Disable Impersonation
role	string	No	—	The role value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "membershipId": {
      "type": "number",
      "description": "Membership Id"
    },
    "accepted": {
      "type": "boolean",
      "description": "The accepted value"
    },
    "disableImpersonation": {
      "type": "boolean",
      "description": "Disable Impersonation"
    },
    "role": {
      "type": "string",
      "description": "The role value",
      "enum": [
        "MEMBER",
        "OWNER",
        "ADMIN"
      ]
    }
  },
  "required": [
    "PCID",
    "orgId",
    "membershipId"
  ]
}

---

cal_organizations_users_controller_create_organization_user

Create a user

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
appTheme	string	null	No	—	Application theme
autoAccept	boolean	No	—	Auto Accept
avatarUrl	string	No	—	Avatar URL
bio	string	No	—	The bio value
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	null	No	—	Locale or language code
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	—	Organization Role
theme	string	null	No	—	The theme value
timeFormat	number	No	—	Time format
timeZone	string	No	—	Time zone
username	string	No	—	The username value
weekday	string	No	—	Preferred weekday

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "appTheme": {
      "type": [
        "string",
        "null"
      ],
      "description": "Application theme"
    },
    "autoAccept": {
      "type": "boolean",
      "description": "Auto Accept"
    },
    "avatarUrl": {
      "type": "string",
      "description": "Avatar URL"
    },
    "bio": {
      "type": "string",
      "description": "The bio value"
    },
    "brandColor": {
      "type": "string",
      "description": "Brand color in HEX format"
    },
    "darkBrandColor": {
      "type": "string",
      "description": "Dark brand color in HEX format"
    },
    "defaultScheduleId": {
      "type": "number",
      "description": "Default schedule ID"
    },
    "email": {
      "type": "string",
      "description": "User email address"
    },
    "hideBranding": {
      "type": "boolean",
      "description": "Hide branding"
    },
    "locale": {
      "type": [
        "string",
        "null"
      ],
      "description": "Locale or language code"
    },
    "metadata": {
      "type": "object",
      "description": "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": {
      "type": "string",
      "description": "Organization Role",
      "enum": [
        "MEMBER",
        "ADMIN",
        "OWNER"
      ]
    },
    "theme": {
      "type": [
        "string",
        "null"
      ],
      "description": "The theme value"
    },
    "timeFormat": {
      "type": "number",
      "description": "Time format"
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone"
    },
    "username": {
      "type": "string",
      "description": "The username value"
    },
    "weekday": {
      "type": "string",
      "description": "Preferred weekday"
    }
  },
  "required": [
    "PCID",
    "orgId",
    "email"
  ]
}

---

cal_organizations_users_controller_delete_organization_user

Delete a user

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
userId	number	Yes	—	User Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "userId": {
      "type": "number",
      "description": "User Id"
    }
  },
  "required": [
    "PCID",
    "orgId",
    "userId"
  ]
}

---

cal_organizations_users_controller_get_organizations_users

Get all users

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
take	number	No	—	The number of items to return
skip	number	No	—	The number of items to skip
emails	string[]	No	—	The email address or an array of email addresses to filter by
assignedOptionIds	string[]	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	number[]	No	—	Filter by teamIds. Team ids must be separated by a comma.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "take": {
      "type": "number",
      "description": "The number of items to return"
    },
    "skip": {
      "type": "number",
      "description": "The number of items to skip"
    },
    "emails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The email address or an array of email addresses to filter by"
    },
    "assignedOptionIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Filter by assigned attribute option ids. ids must be separated by a comma."
    },
    "attributeQueryOperator": {
      "type": "string",
      "description": "Query operator used to filter assigned options, AND by default.",
      "enum": [
        "OR",
        "AND",
        "NONE"
      ]
    },
    "teamIds": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "Filter by teamIds. Team ids must be separated by a comma."
    }
  },
  "required": [
    "PCID",
    "orgId"
  ]
}

---

cal_organizations_users_controller_update_organization_user

Update a user

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
userId	number	Yes	—	User Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "userId": {
      "type": "number",
      "description": "User Id"
    }
  },
  "required": [
    "PCID",
    "orgId",
    "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	—	User Id
orgId	number	Yes	—	Org Id
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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "number",
      "description": "User Id"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "end": {
      "type": "string",
      "description": "The end date and time of the out of office period in ISO 8601 format in UTC timezone."
    },
    "notes": {
      "type": "string",
      "description": "Optional notes for the out of office entry."
    },
    "reason": {
      "type": "string",
      "description": "the reason for the out of office entry, if applicable",
      "enum": [
        "unspecified",
        "vacation",
        "travel",
        "sick",
        "public_holiday"
      ]
    },
    "start": {
      "type": "string",
      "description": "The start date and time of the out of office period in ISO 8601 format in UTC timezone."
    },
    "toUserId": {
      "type": "number",
      "description": "The ID of the user covering for the out of office period, if applicable."
    }
  },
  "required": [
    "PCID",
    "userId",
    "orgId",
    "end",
    "start"
  ]
}

---

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	—	Ooo Id
userId	number	Yes	—	User Id
orgId	number	Yes	—	Org Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "oooId": {
      "type": "number",
      "description": "Ooo Id"
    },
    "userId": {
      "type": "number",
      "description": "User Id"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    }
  },
  "required": [
    "PCID",
    "oooId",
    "userId",
    "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	—	User Id
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	—	Org Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "number",
      "description": "User Id"
    },
    "take": {
      "type": "number",
      "description": "Maximum number of items to return"
    },
    "skip": {
      "type": "number",
      "description": "Number of items to skip"
    },
    "sortStart": {
      "type": "string",
      "description": "Sort results by their start time in ascending or descending order.",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "sortEnd": {
      "type": "string",
      "description": "Sort results by their end time in ascending or descending order.",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    }
  },
  "required": [
    "PCID",
    "userId",
    "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	—	Org Id
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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "take": {
      "type": "number",
      "description": "Maximum number of items to return"
    },
    "skip": {
      "type": "number",
      "description": "Number of items to skip"
    },
    "sortStart": {
      "type": "string",
      "description": "Sort results by their start time in ascending or descending order.",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "sortEnd": {
      "type": "string",
      "description": "Sort results by their end time in ascending or descending order.",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "email": {
      "type": "string",
      "description": "Filter ooo entries by the user email address. user must be within your organization."
    }
  },
  "required": [
    "PCID",
    "orgId"
  ]
}

---

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	—	User Id
oooId	number	Yes	—	Ooo Id
orgId	number	Yes	—	Org Id
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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "number",
      "description": "User Id"
    },
    "oooId": {
      "type": "number",
      "description": "Ooo Id"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "end": {
      "type": "string",
      "description": "The end date and time of the out of office period in ISO 8601 format in UTC timezone."
    },
    "notes": {
      "type": "string",
      "description": "Optional notes for the out of office entry."
    },
    "reason": {
      "type": "string",
      "description": "the reason for the out of office entry, if applicable",
      "enum": [
        "unspecified",
        "vacation",
        "travel",
        "sick",
        "public_holiday"
      ]
    },
    "start": {
      "type": "string",
      "description": "The start date and time of the out of office period in ISO 8601 format in UTC timezone."
    },
    "toUserId": {
      "type": "number",
      "description": "The ID of the user covering for the out of office period, if applicable."
    }
  },
  "required": [
    "PCID",
    "userId",
    "oooId",
    "orgId"
  ]
}

---

cal_organizations_webhooks_controller_create_organization_webhook

Create a webhook

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
active	boolean	Yes	—	The active value
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	—	The secret value
subscriberUrl	string	Yes	—	Subscriber Url
triggers	string[]	Yes	—	The triggers value
version	string	No	—	The version of the webhook

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "active": {
      "type": "boolean",
      "description": "The active value"
    },
    "payloadTemplate": {
      "type": "string",
      "description": "The template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information"
    },
    "secret": {
      "type": "string",
      "description": "The secret value"
    },
    "subscriberUrl": {
      "type": "string",
      "description": "Subscriber Url"
    },
    "triggers": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "BOOKING_CREATED",
          "BOOKING_PAYMENT_INITIATED",
          "BOOKING_PAID",
          "BOOKING_RESCHEDULED",
          "BOOKING_REQUESTED",
          "BOOKING_CANCELLED",
          "BOOKING_REJECTED",
          "BOOKING_NO_SHOW_UPDATED",
          "FORM_SUBMITTED",
          "MEETING_ENDED",
          "MEETING_STARTED",
          "RECORDING_READY",
          "INSTANT_MEETING",
          "RECORDING_TRANSCRIPTION_GENERATED",
          "OOO_CREATED",
          "AFTER_HOSTS_CAL_VIDEO_NO_SHOW",
          "AFTER_GUESTS_CAL_VIDEO_NO_SHOW",
          "FORM_SUBMITTED_NO_EVENT",
          "ROUTING_FORM_FALLBACK_HIT",
          "DELEGATION_CREDENTIAL_ERROR",
          "WRONG_ASSIGNMENT_REPORT"
        ]
      },
      "description": "The triggers value"
    },
    "version": {
      "type": "string",
      "description": "The version of the webhook",
      "enum": [
        "2021-10-20"
      ]
    }
  },
  "required": [
    "PCID",
    "orgId",
    "active",
    "subscriberUrl",
    "triggers"
  ]
}

---

cal_organizations_webhooks_controller_delete_webhook

Delete a webhook

Parameters:

Parameter	Type	Required	Default	Description
webhookId	string	Yes	—	Webhook Id
orgId	number	Yes	—	Org Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "webhookId": {
      "type": "string",
      "description": "Webhook Id"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    }
  },
  "required": [
    "PCID",
    "webhookId",
    "orgId"
  ]
}

---

cal_organizations_webhooks_controller_get_all_organization_webhooks

Get all webhooks

Parameters:

Parameter	Type	Required	Default	Description
orgId	number	Yes	—	Org Id
take	number	No	—	Maximum number of items to return
skip	number	No	—	Number of items to skip

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "take": {
      "type": "number",
      "description": "Maximum number of items to return"
    },
    "skip": {
      "type": "number",
      "description": "Number of items to skip"
    }
  },
  "required": [
    "PCID",
    "orgId"
  ]
}

---

cal_organizations_webhooks_controller_get_organization_webhook

Get a webhook

Parameters:

Parameter	Type	Required	Default	Description
webhookId	string	Yes	—	Webhook Id
orgId	number	Yes	—	Org Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "webhookId": {
      "type": "string",
      "description": "Webhook Id"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    }
  },
  "required": [
    "PCID",
    "webhookId",
    "orgId"
  ]
}

---

cal_organizations_webhooks_controller_update_org_webhook

Update a webhook

Parameters:

Parameter	Type	Required	Default	Description
webhookId	string	Yes	—	Webhook Id
orgId	number	Yes	—	Org Id
active	boolean	No	—	The active value
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	—	The secret value
subscriberUrl	string	No	—	Subscriber Url
triggers	string[]	No	—	The triggers value
version	string	No	—	The version of the webhook

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "webhookId": {
      "type": "string",
      "description": "Webhook Id"
    },
    "orgId": {
      "type": "number",
      "description": "Org Id"
    },
    "active": {
      "type": "boolean",
      "description": "The active value"
    },
    "payloadTemplate": {
      "type": "string",
      "description": "The template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information"
    },
    "secret": {
      "type": "string",
      "description": "The secret value"
    },
    "subscriberUrl": {
      "type": "string",
      "description": "Subscriber Url"
    },
    "triggers": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "BOOKING_CREATED",
          "BOOKING_PAYMENT_INITIATED",
          "BOOKING_PAID",
          "BOOKING_RESCHEDULED",
          "BOOKING_REQUESTED",
          "BOOKING_CANCELLED",
          "BOOKING_REJECTED",
          "BOOKING_NO_SHOW_UPDATED",
          "FORM_SUBMITTED",
          "MEETING_ENDED",
          "MEETING_STARTED",
          "RECORDING_READY",
          "INSTANT_MEETING",
          "RECORDING_TRANSCRIPTION_GENERATED",
          "OOO_CREATED",
          "AFTER_HOSTS_CAL_VIDEO_NO_SHOW",
          "AFTER_GUESTS_CAL_VIDEO_NO_SHOW",
          "FORM_SUBMITTED_NO_EVENT",
          "ROUTING_FORM_FALLBACK_HIT",
          "DELEGATION_CREDENTIAL_ERROR",
          "WRONG_ASSIGNMENT_REPORT"
        ]
      },
      "description": "The triggers value"
    },
    "version": {
      "type": "string",
      "description": "The version of the webhook",
      "enum": [
        "2021-10-20"
      ]
    }
  },
  "required": [
    "PCID",
    "webhookId",
    "orgId"
  ]
}