Get Cal.com Integration
Endpoint used to get a Cal.com integration.
Request Example
Section titled “Request Example”curl --request GET \ --url https://converflow.api.prod.toolzz.media/api/v1/calcom/integration/{integrationId} \ --header 'Authorization: Bearer TOKEN_HERE'Response Example
Section titled “Response Example”{ "id": "uuid", "botId": null, "unitId": "uuid", "title": "string", "calcomUsername": "string", "apiKey": "cal_string", "isActive": true, "isTokenMasked": true, "timezone": "string", "prompt": "string", "checkAvailabilityEnabled": boolean, "createBookingEnabled": boolean, "defaultEventTypeId": null, "defaultEventTypeSlug": null, "createdAt": "YYYY-MM-DD HH:mm:ss.SSSSSS", "updatedAt": "YYYY-MM-DD HH:mm:ss.SSS"}Request description
Section titled “Request description”Access Token
Section titled “Access Token”| Parameter | Type | Description | Required |
|---|---|---|---|
Authorization | String | Access token (“Bearer” must be before the token) | Yes |
URL Parameters
Section titled “URL Parameters”| Parameter | Type | Description | Required |
|---|---|---|---|
integrationId | String | Cal.com integration ID | Yes |
Response description
Section titled “Response description”| Key | Type | Description | Required |
|---|---|---|---|
id | UUID | Unique configuration identifier in the database. | Yes |
botId | Null/UUID | Toolzz AI Agent ID: Identifier of the AI linked to this calendar. | No |
unitId | UUID | Unique identifier of the owning organizational unit. | Yes |
title | String | Friendly name assigned to the integration (e.g., “Calcom”). | Yes |
calcomUsername | String | Username or profile slug on the Cal.com platform. | Yes |
apiKey | String | API key masked by asterisks for data protection. | Yes |
isActive | Boolean | Defines if the integration is enabled for use in the system. | Yes |
isTokenMasked | Boolean | Confirms that the apiKey is hidden in the response. | Yes |
timezone | String | Default timezone used for appointments. | Yes |
prompt | String | Function Instruction: Commands that guide the AI in the chat. | Yes |
checkAvailabilityEnabled | Boolean | Indicates if the AI is allowed to read available times. | Yes |
createBookingEnabled | Boolean | Indicates if the AI is allowed to make appointments. | Yes |
defaultEventTypeId | Null/Number | Default event type ID (e.g., 30min meeting ID). | No |
defaultEventTypeSlug | Null/Str | Default event type slug (e.g., 30min). | No |
createdAt | String | Exact timestamp of record creation (ISO 8601). | Yes |
updatedAt | String | Timestamp of the last data update (ISO 8601). | Yes |
Security
Section titled “Security”To access this endpoint, it is necessary to send a valid access token through the authorization header (Authorization) of the request. Additionally, the API is protected by other security measures to safeguard user data.
To access your access token, follow these steps:
- Log in to the ToolzzAI platform
- Click on “Settings”
- Click on “Access Token”
- Copy the access token
