Cal.com
Visão geral
Seção intitulada “Visão geral”O Cal.com é uma plataforma open-source de agendamento que simplifica a coordenação de reuniões por meio de páginas de reserva compartilháveis, sincronização de calendários e gerenciamento de disponibilidade. Com a integração no SquadOS, seus agentes podem criar, cancelar e reagendar reuniões, consultar horários disponíveis, gerenciar tipos de evento e configurar agendas de disponibilidade — tudo de forma programática, sem intervenção manual.
- Site oficial: https://cal.com/
- Documentação na Composio: docs.composio.dev/toolkits/cal
Autenticação
Seção intitulada “Autenticação”Esta ferramenta suporta dois modos de autenticação: OAuth 2.0 (OAUTH2) e chave de API (API_KEY).
Você vai precisar dos seguintes campos (modo API_KEY):
| Campo | Obrigatório | Descrição |
|---|---|---|
api_key | Sim | Chave de API gerada no painel do Cal.com em Settings → Developer → API Keys. |
Para o modo OAuth 2.0, nenhum campo manual é necessário — o fluxo de autorização é concluído na página segura da Composio.
Como obter a credencial
Seção intitulada “Como obter a credencial”Para usar o modo chave de API:
- Acesse app.cal.com e faça login na sua conta.
- Clique em Settings no menu lateral esquerdo.
- Acesse Developer → API Keys.
- Clique em Add para gerar uma nova chave.
- Dê um nome à chave (ex.: “SquadOS”) e defina a data de expiração desejada.
- Copie o valor gerado — ele não será exibido novamente.
Como conectar no SquadOS
Seção intitulada “Como conectar no SquadOS”- Acesse Ferramentas no menu lateral (
/admin/tools). - Abra a aba Disponíveis e procure por
Cal.com. - Clique no card para abrir o modal de detalhes e em Conectar.
- Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso via OAuth 2.0 ou informa a chave de API obtida acima.
- Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)
Ações disponíveis
Seção intitulada “Ações disponíveis”Criar nova reserva
Seção intitulada “Criar nova reserva”CAL_POST_NEW_BOOKING_REQUEST
Cria uma nova reserva para um tipo de evento em um horário de início especificado. Use para agendar uma reunião com um usuário do Cal.com. Pré-requisitos: (1) obter um ID de tipo de evento válido via CAL_LIST_EVENT_TYPES; (2) encontrar um horário disponível via CAL_GET_AVAILABLE_SLOTS_INFO; (3) fornecer nome e e-mail do participante no objeto responses. A reserva será criada com status ACCEPTED se não exigir confirmação, ou PENDING se o tipo de evento exigir aprovação do anfitrião.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
start | string | Sim | Data e hora de início no formato ISO 8601 em UTC (ex.: ‘2024-09-15T10:00:00Z’). Deve ser um horário disponível retornado por CAL_GET_AVAILABLE_SLOTS_INFO. |
language | string | Sim | Código de idioma ISO 639-1 para comunicações com o participante (ex.: ‘pt’ para português, ‘en’ para inglês). |
timeZone | string | Sim | Identificador de fuso horário IANA para o participante (ex.: ‘America/Sao_Paulo’, ‘America/New_York’). |
responses | object | Sim | Objeto com dados do participante. Chaves obrigatórias: name (nome completo) e email (endereço de e-mail válido). |
eventTypeId | integer | Não | ID numérico único do tipo de evento a ser reservado. Obrigatório se eventTypeSlug não for informado. |
eventTypeSlug | string | Não | Slug do tipo de evento. Quando usado, deve ser combinado com username ou teamSlug. |
guests | array | Não | Lista de endereços de e-mail de convidados adicionais. |
location | object | Não | Objeto de localização correspondente a uma das localizações configuradas no tipo de evento. |
metadata | object | Não | Metadados customizados chave-valor para rastreamento ou análises. Máximo de 50 chaves. |
lengthInMinutes | integer | Não | Duração do evento em minutos. Usar apenas quando o tipo de evento suportar múltiplas durações selecionáveis. |
bookingFieldsResponses | object | Não | Respostas a campos de reserva personalizados definidos no tipo de evento. Obrigatório se o tipo de evento tiver campos obrigatórios customizados. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todas as reservas
Seção intitulada “Listar todas as reservas”CAL_FETCH_ALL_BOOKINGS
Busca a lista de reservas do usuário autenticado, com filtros opcionais por status, participante, intervalo de datas ou IDs de evento/equipe, além de suporte a paginação e ordenação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
skip | integer | Não | Número de reservas a pular no início dos resultados (para paginação). |
take | integer | Não | Número máximo de reservas a retornar (para paginação). |
status | array | Não | Filtrar reservas por status. Ex.: ["upcoming", "past"]. |
teamId | integer | Não | Filtrar por ID de uma equipe da qual o usuário é membro. |
afterStart | string | Não | Filtrar reservas com início após esta data/hora ISO 8601. |
beforeEnd | string | Não | Filtrar reservas com término antes desta data/hora ISO 8601. |
eventTypeId | integer | Não | Filtrar por ID de tipo de evento pertencente ao usuário. |
attendeeEmail | string | Não | Filtrar pelo endereço de e-mail exato de um participante. |
attendeeName | string | Não | Filtrar pelo nome de um participante. |
sortStart | string | Não | Ordenar resultados pelo horário de início (asc ou desc). |
sortEnd | string | Não | Ordenar resultados pelo horário de término (asc ou desc). |
sortCreated | string | Não | Ordenar resultados pela data de criação (asc ou desc). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Consultar detalhes de reserva por UID
Seção intitulada “Consultar detalhes de reserva por UID”CAL_RETRIEVE_BOOKING_DETAILS_BY_UID
Busca todos os detalhes de uma reserva existente, identificada pelo seu bookingUid.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
bookingUid | string | Sim | Identificador único (UID) da reserva. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Reagendar reserva por UID
Seção intitulada “Reagendar reserva por UID”CAL_RESCHEDULE_BOOKING_BY_UID
Reagenda uma reserva existente (identificada pelo bookingUid) para um novo horário. Requer o UID da reserva e o novo horário de início no formato ISO 8601. Opcionalmente, pode-se fornecer o motivo do reagendamento e o e-mail da pessoa que está reagendando.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
bookingUid | string | Sim | Identificador único (UID) da reserva a ser reagendada. |
start | string | Sim | Novo horário de início no formato ISO 8601 com fuso horário (ex.: ‘2024-08-13T10:00:00Z’). |
rescheduledBy | string | Não | E-mail da pessoa que está reagendando. Se for o e-mail do proprietário do tipo de evento, a reserva será confirmada automaticamente. |
reschedulingReason | string | Não | Motivo do reagendamento. |
emailVerificationCode | string | Não | Obrigatório quando o tipo de evento tem verificação de e-mail habilitada. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Cancelar reserva por UID
Seção intitulada “Cancelar reserva por UID”CAL_CANCEL_BOOKING_VIA_UID
Cancela uma reserva ativa do Cal.com usando seu identificador único (UID).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
bookingUid | string | Sim | Identificador único (UID) da reserva a ser cancelada. |
cancellationReason | string | Não | Motivo do cancelamento. Recomendado para comunicação clara com o participante. |
seatUid | string | Não | Apenas para reservas com assentos: UID do assento específico a cancelar. |
cancelSubsequentBookings | boolean | Não | Para reservas recorrentes: se verdadeiro, cancela esta reserva e todas as recorrências subsequentes. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Confirmar reserva por UID
Seção intitulada “Confirmar reserva por UID”CAL_CONFIRM_BOOKING_BY_UID
Confirma uma reserva existente pelo bookingUid, desde que esteja em um estado que permita confirmação (por exemplo, não cancelada ou já confirmada). Finaliza a reserva sem modificar seus detalhes.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
bookingUid | string | Sim | Identificador único (UID) da reserva a ser confirmada. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Recusar reserva com motivo
Seção intitulada “Recusar reserva com motivo”CAL_DECLINE_BOOKING_WITH_REASON
Recusa uma reserva pendente usando seu bookingUid, opcionalmente com um motivo. A ação é irreversível e se aplica apenas a reservas aguardando confirmação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
bookingUid | string | Sim | Identificador único (UID) da reserva a ser recusada. |
reason | string | Não | Motivo fornecido pelo anfitrião para recusar a reserva. Recomendado para comunicação clara com o participante. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Editar reserva por ID
Seção intitulada “Editar reserva por ID”CAL_EDIT_BOOKING_BY_ID
Edita uma reserva existente pelo seu ID. Use para atualizar detalhes como título, descrição, status ou horário.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | ID da reserva a editar. |
title | string | Não | Título do evento da reserva. |
description | string | Não | Descrição da reunião. |
status | string | Não | Status da reserva. Valores possíveis: ACCEPTED, PENDING, CANCELLED, REJECTED. |
start | string | Não | Horário de início do evento no formato ISO 8601. |
end | string | Não | Horário de término do evento no formato ISO 8601. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Marcar ausência em reserva por UID
Seção intitulada “Marcar ausência em reserva por UID”CAL_MARK_BOOKING_ABSENT_FOR_UID
Marca o anfitrião e/ou participantes especificados como ausentes em uma reserva existente. Normalmente usado após um evento agendado para registrar faltas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
bookingUid | string | Sim | Identificador único (UID) da reserva. |
host | boolean | Não | Se verdadeiro, marca o anfitrião como ausente. Se nulo ou omitido, o status de presença do anfitrião não é alterado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Verificar disponibilidade do calendário
Seção intitulada “Verificar disponibilidade do calendário”CAL_CHECK_CALENDAR_VERSION2
Recupera a disponibilidade livre/ocupado de um calendário especificado para auxiliar no agendamento, sem revelar detalhes dos eventos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
calendar | string | Sim | Tipo de calendário para verificar disponibilidade. Deve ser um dos provedores de calendário suportados. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Consultar horários disponíveis
Seção intitulada “Consultar horários disponíveis”CAL_GET_AVAILABLE_SLOTS_INFO
Recupera os horários disponíveis para agendamento, considerando reservas existentes e disponibilidade configurada, com base em um intervalo de datas e tipo de evento.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
eventTypeId | integer | Sim | Identificador numérico único do tipo de evento. |
startTime | string | Sim | Data e hora de início em UTC (formato ISO 8601) a partir da qual buscar horários disponíveis. |
endTime | string | Sim | Data e hora de término em UTC (formato ISO 8601) até a qual buscar horários disponíveis. Deve ser posterior a startTime. |
timeZone | string | Não | Identificador de fuso horário IANA (ex.: ‘America/Sao_Paulo’) para calcular e retornar os horários disponíveis. |
duration | integer | Não | Duração desejada dos horários em minutos. Normalmente usada para eventos dinâmicos onde a duração não é fixa. |
slotFormat | string | Não | Formato dos horários retornados. Use range para início e fim de cada slot; use time para apenas o horário de início. |
usernameList | array | Não | Obrigatório para tipos de evento dinâmicos ou coletivos, para especificar os usuários cuja disponibilidade deve ser considerada. |
rescheduleUid | string | Não | UID de uma reserva existente sendo reagendada. Fornecê-lo ajuda a encontrar slots adequados para o contexto de reagendamento. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Reservar horário temporariamente
Seção intitulada “Reservar horário temporariamente”CAL_RESERVE_SLOT_FOR_EVENT
Reserva temporariamente um horário disponível para um tipo de evento existente. Útil para horários de alta demanda, evitando reservas duplicadas enquanto o usuário conclui o agendamento.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
eventTypeId | integer | Sim | Identificador único do tipo de evento para o qual o horário está sendo reservado. |
slotUtcStartDate | string | Sim | Data e hora de início do slot a reservar, em UTC (formato ISO 8601). |
slotUtcEndDate | string | Sim | Data e hora de término do slot a reservar, em UTC (formato ISO 8601). |
bookingUid | string | Não | Identificador opcional, normalmente usado para eventos com assentos. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar tipos de evento
Seção intitulada “Listar tipos de evento”CAL_LIST_EVENT_TYPES
Recupera os tipos de evento do Cal.com, com filtros opcionais por username, múltiplos usernames ou detalhes da organização (orgSlug ou orgId).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
username | string | Não | Nome de usuário cujos tipos de evento devem ser recuperados. Obrigatório se eventSlug for informado. |
eventSlug | string | Não | Slug de um tipo de evento específico a recuperar. Se informado, username também deve ser fornecido. |
usernames | string | Não | String com nomes de usuário separados por vírgula para recuperar tipos de evento dinâmicos de múltiplos usuários (ex.: ‘alice,bob’). |
orgId | integer | Não | ID único da organização. |
orgSlug | string | Não | Slug da organização. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Consultar detalhes de tipo de evento por ID
Seção intitulada “Consultar detalhes de tipo de evento por ID”CAL_RETRIEVE_EVENT_TYPE_BY_ID
Recupera todos os detalhes de um tipo de evento específico do Cal.com pelo seu ID único. Ação somente de leitura — não retorna eventos ou reservas associadas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
eventTypeId | string | Sim | Identificador único do tipo de evento. Valor numérico ou UUID encontrado na URL das configurações do tipo de evento. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Editar tipo de evento por ID
Seção intitulada “Editar tipo de evento por ID”CAL_EDIT_EVENT_TYPE_BY_ID
Edita um tipo de evento existente do Cal.com pelo ID. Use para atualizar configurações como título, descrição, duração, localizações ou configurações de reserva.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | ID do tipo de evento a editar. |
title | string | Não | Título do tipo de evento. |
slug | string | Não | Slug único para o tipo de evento. |
hidden | boolean | Não | Se o tipo de evento deve ser ocultado da sua página pública de reservas. |
price | integer | Não | Preço da reserva do tipo de evento. |
hosts | array | Não | Lista de anfitriões para tipos de evento de equipe. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir tipo de evento por ID
Seção intitulada “Excluir tipo de evento por ID”CAL_DELETE_EVENT_TYPE_BY_ID
Exclui permanentemente um tipo de evento existente pelo seu ID. A operação é irreversível e invalida os links de agendamento associados; reservas existentes não são afetadas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
eventTypeId | integer | Sim | Identificador numérico único do tipo de evento a ser excluído. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar agendas de disponibilidade
Seção intitulada “Listar agendas de disponibilidade”CAL_RETRIEVE_SCHEDULES_LIST
Recupera todas as agendas de disponibilidade do usuário autenticado no Cal.com. Cada agenda inclui blocos de horário, fuso horário e se é a agenda padrão. Retorna lista vazia se nenhuma agenda estiver configurada.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Consultar agenda por ID
Seção intitulada “Consultar agenda por ID”CAL_FETCH_SCHEDULE_BY_ID
Busca todos os detalhes de uma agenda específica usando seu scheduleId.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
scheduleId | integer | Sim | Identificador único da agenda a recuperar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar agenda de disponibilidade
Seção intitulada “Criar agenda de disponibilidade”CAL_CREATE_USER_AVAILABILITY_SCHEDULE
Cria uma agenda de disponibilidade no Cal.com, definindo nome, fuso horário, disponibilidade semanal recorrente e substituições para datas específicas. Se isDefault for verdadeiro, esta agenda substitui a agenda padrão existente.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome descritivo da agenda (ex.: ‘Horário de Trabalho’, ‘Agenda de Férias’). |
timeZone | string | Sim | Identificador de fuso horário IANA (ex.: ‘America/Sao_Paulo’). Essencial para cálculo correto da disponibilidade. |
isDefault | boolean | Sim | Define esta como a agenda padrão do usuário se verdadeiro, substituindo a existente. Cada usuário deve ter exatamente uma agenda padrão. |
availability | array | Não | Lista de objetos de disponibilidade definindo dias ativos e horários. Se omitido, aplica o padrão (seg-sex, 09:00–17:00 no fuso da agenda). |
overrides | array | Não | Lista de objetos de substituição para exceções de datas específicas (ex.: feriados). As substituições têm precedência sobre a disponibilidade semanal. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Editar disponibilidade por ID
Seção intitulada “Editar disponibilidade por ID”CAL_EDIT_AVAILABILITY_BY_ID
Edita uma disponibilidade existente pelo ID no Cal.com. Use para atualizar dias, horário de início, horário de término ou a associação com uma agenda.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | ID da disponibilidade a editar. |
days | array | Não | Array de inteiros representando dias da semana (0=domingo, 1=segunda, 2=terça, 3=quarta, 4=quinta, 5=sexta, 6=sábado). Apenas valores 0–6 são válidos. |
startTime | string | Não | Horário de início no formato ISO 8601 (ex.: ‘1970-01-01T10:00:00.000Z’). A parte de data é ignorada; apenas o horário é usado. |
endTime | string | Não | Horário de término no formato ISO 8601 (ex.: ‘1970-01-01T16:00:00.000Z’). A parte de data é ignorada; apenas o horário é usado. |
scheduleId | integer | Não | ID da agenda à qual esta disponibilidade está associada. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir agenda por ID
Seção intitulada “Excluir agenda por ID”CAL_DELETE_SCHEDULE_BY_ID
Exclui permanentemente uma agenda específica usando seu identificador único.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
scheduleId | integer | Sim | Identificador único da agenda a ser excluída. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Consultar minhas informações
Seção intitulada “Consultar minhas informações”CAL_RETRIEVE_MY_INFORMATION
Recupera as informações de perfil principal do usuário autenticado (ex.: nome, e-mail, fuso horário). Não recupera dados relacionados como eventos de calendário ou agendas.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar equipes
Seção intitulada “Listar equipes”CAL_GET_TEAMS_LIST
Recupera todas as equipes às quais o usuário pertence, incluindo nomes e membros.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Adicionar participante
Seção intitulada “Adicionar participante”CAL_ADD_ATTENDEE
Cria um novo participante para uma reserva existente no Cal.com. Use quando precisar adicionar um participante adicional a um evento agendado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
bookingId | integer | Sim | Identificador único da reserva à qual o participante será adicionado. |
name | string | Sim | Nome completo do participante. |
email | string | Sim | Endereço de e-mail do participante. Deve ser um formato de e-mail válido. |
timeZone | string | Sim | Fuso horário IANA do participante (ex.: ‘America/Sao_Paulo’, ‘Europe/London’). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todos os participantes
Seção intitulada “Listar todos os participantes”CAL_LIST_ATTENDEES
Recupera todos os participantes do Cal.com. Use quando precisar obter a lista completa de participantes em todas as reservas.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Consultar detalhes de tipo de evento de equipe
Seção intitulada “Consultar detalhes de tipo de evento de equipe”CAL_FETCH_EVENT_TYPE_DETAILS
Busca todas as configurações de um tipo de evento de equipe, identificado por orgId, teamId e eventTypeId. Ação somente de leitura.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
orgId | integer | Sim | Identificador único da organização à qual o tipo de evento pertence. |
teamId | integer | Sim | Identificador único da equipe, dentro da organização especificada. |
eventTypeId | integer | Sim | Identificador único do tipo de evento específico. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Reagendar reserva para outro usuário
Seção intitulada “Reagendar reserva para outro usuário”CAL_REASSIGN_BOOKING_TO_ANOTHER_USER
Reatribui uma reserva existente a um usuário especificado. O proprietário da reserva deve estar autorizado a realizar a reatribuição.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
bookingUid | string | Sim | Identificador único (UID) da reserva a ser reatribuída. |
reason | string | Não | Texto explicando o motivo da reatribuição. Útil para rastreamento ou comunicação interna. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |