Calendly

Visão geral

O Calendly é uma ferramenta de agendamento de compromissos que automatiza convites de reunião, verificação de disponibilidade e lembretes, eliminando a troca interminável de e-mails entre participantes. Com a integração no SquadOS, seus agentes podem criar tipos de evento, agendar reuniões, consultar horários disponíveis e gerenciar membros da organização diretamente via API, tornando fluxos de agendamento completamente automatizados.

• Site oficial: https://calendly.com/
• Documentação na Composio: docs.composio.dev/toolkits/calendly

Autenticação

Esta ferramenta utiliza OAuth 2.0 (OAUTH2) para conectar.

Você vai precisar dos seguintes campos:

Campo	Obrigatório	Descrição
client_id	Sim	ID do cliente gerado ao criar o aplicativo OAuth no portal do desenvolvedor Calendly.
client_secret	Sim	Segredo do cliente gerado junto com o Client ID no portal do desenvolvedor Calendly.

Como obter a credencial

1. Acesse developer.calendly.com e faça login com sua conta Calendly.
2. Clique em My Apps e depois em Create New App.
3. Preencha o formulário do aplicativo: nome (ex.: Composio-Calendly), tipo Web e ambiente Sandbox (testes) ou Production (produção).
4. No campo Redirect URI, informe: https://backend.composio.dev/api/v3/toolkits/auth/callback (HTTPS obrigatório, sem barra final).
5. Salve o Client ID e o Client Secret gerados — você precisará deles na próxima etapa.
6. Confirme que o redirect URI aparece corretamente nas configurações do aplicativo.
7. Acesse platform.composio.dev e clique em Create Auth Config, selecionando Calendly.
8. Defina o tipo de autenticação como OAuth2 e habilite Use your own developer authentication.
9. Cole o Client ID e o Client Secret na aba Manage Auth Config e clique em criar.
10. Copie o Auth Config ID gerado (começa com ac_) — você precisará dele ao conectar no SquadOS.

Dica

Use os escopos mínimos necessários ao criar seu aplicativo: default, users:read, events:read, event_types:read e webhook_subscriptions:write. O modelo OAuth do Calendly concede todos os escopos solicitados de uma vez — não é possível aprovar escopos individualmente depois.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por Calendly.
3. Clique no card para abrir o modal de detalhes e em Conectar.
4. Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso via OAuth 2.0.
5. 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.)

Perguntas frequentes

Por que não consigo configurar escopos individuais para o Calendly?

O modelo OAuth do Calendly concede o token de acesso para todos os escopos solicitados de uma vez durante a autorização — os usuários não podem aprovar escopos individuais seletivamente. Configure os escopos ao criar seu aplicativo OAuth; o token de acesso resultante incluirá todas as permissões solicitadas.

Ações disponíveis

Cancelar evento agendado

CALENDLY_CANCEL_SCHEDULED_EVENT

Cancela um evento Calendly agendado criando um registro de cancelamento. Use quando precisar cancelar permanentemente um evento ativo existente. O cancelamento disparará notificações para todos os convidados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
reason	string	Não	Texto explicativo opcional sobre o motivo do cancelamento. Será incluído na notificação de cancelamento enviada aos convidados.
event_uuid	string	Sim	O identificador único (UUID) do evento agendado a cancelar. Pode ser extraído do URI de scheduled_events ou dos detalhes do evento.

Saí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.

Criar convidado de evento (Descontinuado)

CALENDLY_CREATE_EVENT_INVITEE

DESCONTINUADO: Use CALENDLY_POST_INVITEE em vez desta ação. Agenda reuniões Calendly programaticamente sem redirecionamentos de UI. Use quando precisar reservar uma reunião em nome de um convidado via API. Requer um plano Calendly pago.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
invitee	object	Sim	Detalhes do participante a ser agendado para a reunião.
location	object	Sim	Detalhes do local da reunião. Obrigatório a menos que o tipo de evento não especifique local.
tracking	object	Não	Parâmetros UTM e informações de rastreamento para atribuição de marketing.
event_type	string	Sim	O tipo de evento a reservar. Aceita o URI completo (ex.: 'https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA') ou apenas o UUID. Use a ação list_user_s_event_types para obter os tipos de evento disponíveis.
start_time	string	Sim	Horário de início da reunião em formato ISO 8601 UTC (ex.: '2025-10-02T18:30:00Z'). Use a ação list_event_type_available_times para verificar os horários disponíveis antes de reservar.
event_guests	array	Não	Lista de endereços de e-mail adicionais para incluir como convidados na reunião.
questions_and_answers	array	Não	Lista de respostas a perguntas personalizadas do formulário de reserva. Inclua apenas se o tipo de evento tiver perguntas personalizadas.

Saí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.

Criar tipo de evento

CALENDLY_CREATE_EVENT_TYPE

Cria um novo tipo de evento individual (kind: solo) no Calendly. Use quando precisar criar programaticamente um novo tipo de evento para agendamento de reuniões.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	O nome do tipo de evento que será exibido aos convidados.
color	string	Não	Valor de cor hexadecimal para a página de agendamento. Deve corresponder ao padrão ^#[a-f\d]{6}$ (ex.: '#fff200').
owner	string	Sim	URI do proprietário para este tipo de evento (ex.: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA'). Deve ser um URI de usuário válido.
active	boolean	Não	Indica se o tipo de evento está ativo e disponível para reserva. Padrão: false se não fornecido.
locale	string	Não	Idioma para a página de agendamento do tipo de evento. Opções: "de", "en", "es", "fr", "it", "nl", "pt", "uk".
duration	integer	Não	Duração das sessões em minutos. Deve ser entre 1 e 720 minutos. Deve ser uma das duration_options se ambos forem fornecidos.
locations	array	Não	Informações de configuração para cada possível local onde o evento pode ocorrer.
description	string	Não	A descrição do tipo de evento que será exibida na página de agendamento.
duration_options	array	Não	Opções de duração alternativas para reuniões flexíveis. Máximo de 4 valores únicos. Cada um deve ser entre 1 e 720 minutos.

Saí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.

Criar tipo de evento único

CALENDLY_CREATE_ONE_OFF_EVENT_TYPE

Cria um tipo de evento único e temporário no Calendly para reuniões fora da disponibilidade regular, exigindo URIs válidos de host/co-host, uma data futura/intervalo para date_setting e uma duration positiva.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
host	string	Sim	URI do usuário que será o anfitrião do evento único (ex.: 'https://api.calendly.com/users/xxx').
name	string	Sim	Nome do tipo de evento único.
duration	integer	Sim	Duração do evento em minutos. Passe como 'duration', não 'duration_minutes'.
location	object	Não	Configuração do local para o evento.
timezone	string	Não	Identificador de fuso horário IANA para o agendamento do evento. Determina como os horários são interpretados e exibidos aos convidados.
date_setting	string	Sim	Disponibilidade de data e horário para este evento único. Deve ser um objeto com a chave type igual a: 'date_range', 'days_in_future' ou 'spots'. date_range: inclua start_date e end_date (YYYY-MM-DD). days_in_future: inclua days (int) e only_weekdays (bool). spots: inclua spots — lista de objetos com start_time e end_time (strings datetime ISO 8601). Não use valores como 'available_moving' — esses pertencem a Shares, não a eventos únicos.

Saí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.

Criar link de agendamento

CALENDLY_CREATE_SCHEDULING_LINK

Cria um link de agendamento que pode ser usado para reservar um evento. O link permite que convidados agendem até o número máximo especificado de eventos. Após atingir o limite, o link fica inativo.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
owner	string	Sim	URI do tipo de evento (ex.: 'https://api.calendly.com/event_types/...').
owner_type	string	Não	Tipo do proprietário, tipicamente 'EventType'.
max_event_count	integer	Não	Número máximo de eventos que podem ser agendados com este link. Deve ser exatamente 1 para links de uso único.

Saí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.

Criar compartilhamento

CALENDLY_CREATE_SHARE

Cria um link de compartilhamento personalizável e único para um tipo de evento Calendly, permitindo substituições específicas em suas configurações (ex.: duração, disponibilidade, local) sem alterar o tipo de evento original.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Não	Nome personalizado para o link compartilhado; usa o nome do tipo de evento por padrão se não especificado.
duration	integer	Não	Duração personalizada do evento em minutos, sobrepondo o padrão do tipo de evento.
end_date	string	Não	Data de término (YYYY-MM-DD) para disponibilidade do link compartilhado; obrigatório se period_type for 'fixed'.
event_type	string	Sim	URI do tipo de evento no qual basear este compartilhamento.
start_date	string	Não	Data de início (YYYY-MM-DD) para disponibilidade do link compartilhado; obrigatório se period_type for 'fixed'.
period_type	string	Não	Tipo de período de disponibilidade: 'available_moving' (mostra horários disponíveis reais para max_booking_time dias), 'moving' (disponível por max_booking_time dias), 'fixed' (dentro de start_date/end_date), 'unlimited'.
hide_location	boolean	Não	Se verdadeiro, oculta o local do evento até a reserva (somente se o tipo de evento tiver um único local personalizado).
duration_options	array	Não	Durações selecionáveis alternativas em minutos, sobrepondo as opções do tipo de evento.
max_booking_time	integer	Não	Máximo de dias com antecedência que um convidado pode reservar; obrigatório se period_type for 'moving' ou 'available_moving'.
location_configurations	array	Não	Configurações de local personalizadas que substituem os locais padrão do tipo de evento.
availability__rule__rules	array	Não	Lista de regras de disponibilidade personalizadas que substituem o agendamento padrão do tipo de evento. Forneça um array de objetos com: type='wday', wday (dia da semana) e intervals (lista de {from, to} horários). Os nomes dos campos diferenciam maiúsculas de minúsculas — use wday, from, to exatamente. Deve ser combinado com availability_rule_timezone.
availability__rule__timezone	string	Não	Fuso horário IANA (ex.: 'America/New_York') para regras de disponibilidade personalizadas. Obrigatório com availability_rule_rules.

Saí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.

Criar link de agendamento de uso único

CALENDLY_CREATE_SINGLE_USE_SCHEDULING_LINK

Cria um link de agendamento único e de uso único para um tipo de evento Calendly ativo, expirando após uma reserva.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
owner	string	Sim	URI do tipo de evento Calendly que será proprietário deste link de agendamento de uso único. As configurações do tipo de evento (ex.: duração, disponibilidade) serão aplicadas à reunião agendada.
owner_type	string	Sim	Identifica o tipo de recurso do proprietário, que é 'EventType'.
max_event_count	integer	Sim	Número máximo de eventos que podem ser agendados com este link. Para um link de uso único, este valor deve ser 1.

Saí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.

Criar assinatura de webhook

CALENDLY_CREATE_WEBHOOKS

Cria uma assinatura de webhook para receber notificações de eventos do Calendly. Use quando precisar configurar notificações automatizadas para eventos como reservas ou cancelamentos de reuniões. O escopo de organização dispara webhooks para todos os eventos da organização, enquanto escopos de usuário/grupo limitam os disparos a usuários ou grupos específicos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
url	string	Sim	URL de callback HTTPS publicamente acessível onde os eventos de webhook serão enviados via POST. Deve estar ativa e capaz de receber requisições POST.
user	string	Não	Referência URI ao usuário para webhooks com escopo de usuário (ex.: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA'). Obrigatório quando o escopo é 'user'.
group	string	Não	Referência URI ao grupo para webhooks com escopo de grupo (ex.: 'https://api.calendly.com/groups/AAAAAAAAAAAAAAAA'). Obrigatório quando o escopo é 'group'.
scope	string	Sim	Escopo da assinatura determinando quais eventos disparam o webhook. 'organization' dispara para todos os eventos da organização, 'user' apenas para eventos de um usuário específico, 'group' apenas para eventos de um grupo específico.
events	array	Sim	Lista de tipos de evento para assinar. Valores válidos: 'invitee.created', 'invitee.canceled', 'invitee_no_show.created', 'invitee_no_show.deleted', 'routing_form_submission.created', 'event_type.created', 'event_type.deleted', 'event_type.updated'. Pelo menos um evento deve ser especificado.
signing_key	string	Não	Chave secreta opcional (6–24 caracteres) usada para gerar assinaturas para validação de segurança do webhook. Ajuda a verificar que as requisições POST são genuinamente do Calendly.
organization	string	Sim	Referência URI à organização proprietária desta assinatura de webhook (ex.: 'https://api.calendly.com/organizations/AAAAAAAAAAAAAAAA'). Obrigatório para todas as assinaturas de webhook.

Saí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.

Excluir dados de convidado

CALENDLY_DELETE_INVITEE_DATA

Remove permanentemente todos os dados de convidado associados aos e-mails fornecidos de eventos anteriores da organização, para conformidade com privacidade de dados (requer assinatura Enterprise; a exclusão pode levar até uma semana).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
emails	array	Sim	Endereços de e-mail dos convidados cujos dados associados serão removidos permanentemente.

Saí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.

Excluir registro de ausência de convidado

CALENDLY_DELETE_INVITEE_NO_SHOW

Exclui um registro de ausência de convidado pelo seu uuid para reverter o status de “não compareceu” de um convidado; o uuid deve se referir a um registro existente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
uuid	string	Sim	O identificador único (UUID) do registro de ausência de convidado a ser removido.

Saí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.

Excluir membro da organização

CALENDLY_DELETE_ORGANIZATION_MEMBERSHIP

Remove um usuário de uma organização Calendly pelo UUID de membro. Use quando precisar revogar o acesso de um usuário a uma organização. Requer direitos de administrador; proprietários de organizações não podem ser removidos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
uuid	string	Sim	O identificador único da adesão à organização a ser removida. Este é o UUID de adesão, não o UUID do usuário.

Saí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.

Excluir dados de evento agendado

CALENDLY_DELETE_SCHEDULED_EVENT_DATA

Para usuários Enterprise, inicia a exclusão dos dados de eventos agendados de uma organização entre start_time e end_time (inclusive, onde start_time deve ser anterior ou igual a end_time); a exclusão real dos dados pode levar até 7 dias para ser concluída.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
end_time	string	Sim	Define o fim do período de exclusão de dados (UTC). Eventos terminando neste horário ou antes serão incluídos. Deve estar nos últimos 24 meses.
start_time	string	Sim	Define o início do período de exclusão de dados (UTC). Eventos começando neste horário ou depois serão incluídos. Deve estar nos últimos 24 meses.

Saí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.

Excluir assinatura de webhook

CALENDLY_DELETE_WEBHOOK_SUBSCRIPTION

Exclui uma assinatura de webhook existente para interromper o envio de notificações de eventos do Calendly para a URL de callback registrada; esta operação é idempotente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
webhook_uuid	string	Sim	O identificador único (UUID) da assinatura de webhook a ser excluída.

Saí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.

Obter usuário atual (Descontinuado)

CALENDLY_GET_CURRENT_USER

DESCONTINUADO: Use CALENDLY_GET_USER em vez desta ação. Recupera informações detalhadas sobre o usuário Calendly atualmente autenticado.

Saí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.

Obter evento

CALENDLY_GET_EVENT

Recupera um evento Calendly agendado específico pelo seu UUID, desde que o evento exista na conta Calendly do usuário.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
uuid	string	Sim	Identificador único (UUID) do evento Calendly.

Saí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.

Obter convidado do evento

CALENDLY_GET_EVENT_INVITEE

Recupera informações detalhadas sobre um convidado específico de um evento agendado, usando os UUIDs únicos de ambos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
event_uuid	string	Sim	O identificador único (UUID) do evento agendado.
invitee_uuid	string	Sim	O identificador único (UUID) do convidado para o evento especificado.

Saí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.

Obter tipo de evento

CALENDLY_GET_EVENT_TYPE

Recupera detalhes de um tipo de evento Calendly específico, identificado pelo seu UUID.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
uuid	string	Não	Identificador único (UUID) do tipo de evento. Este é um parâmetro de caminho obrigatório — extraia o UUID do URI do tipo de evento (ex.: para 'https://api.calendly.com/event_types/abc123', use 'abc123').

Saí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.

Obter disponibilidade do tipo de evento

CALENDLY_GET_EVENT_TYPE_AVAILABILITY

Recupera agendas de disponibilidade configuradas para um tipo de evento Calendly específico. Use quando precisar obter as regras de disponibilidade incluindo horários por dia da semana e substituições por data.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user	string	Não	URI do usuário associado ao tipo de evento. Parâmetro opcional para filtrar por usuário.
event_type	string	Sim	URI do tipo de evento cujas agendas de disponibilidade serão listadas. Deve ser um URI de tipo de evento Calendly válido. Recupere este URI de CALENDLY_LIST_EVENT_TYPES; usar um URI não pertencente ao usuário autenticado retorna erro 403.

Saí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.

Obter grupo

CALENDLY_GET_GROUP

Recupera todos os atributos de um grupo Calendly específico pelo seu UUID; o grupo deve existir.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
uuid	string	Sim	Identificador único (UUID) do grupo Calendly.

Saí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.

Obter relacionamento de grupo

CALENDLY_GET_GROUP_RELATIONSHIP

Recupera um relacionamento de grupo Calendly específico pelo seu UUID válido e existente, fornecendo detalhes sobre associações e membros usuário-grupo.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
uuid	string	Sim	O identificador único (UUID) do relacionamento de grupo a ser recuperado.

Saí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.

Obter registro de ausência de convidado

CALENDLY_GET_INVITEE_NO_SHOW

Recupera detalhes de um registro específico de ausência de convidado pelo seu UUID; uma ausência de convidado é marcada quando um convidado não comparece a um evento agendado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
uuid	string	Sim	O identificador único (UUID) do registro de ausência de convidado a recuperar.

Saí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.

Obter organização

CALENDLY_GET_ORGANIZATION

Recupera informações sobre uma organização Calendly específica. Use quando precisar obter detalhes da organização como nome, slug ou timestamps.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
uuid	string	Sim	O identificador único (UUID) da organização a recuperar. É a string alfanumérica no final do URI da organização.

Saí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.

Obter convite da organização

CALENDLY_GET_ORGANIZATION_INVITATION

Recupera um convite específico de organização Calendly usando o UUID do convite e o UUID da organização pai.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
uuid	string	Sim	O identificador único (UUID) do convite de organização específico a recuperar.
org_uuid	string	Sim	O identificador único (UUID) da organização Calendly à qual o convite pertence.

Saí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.

Obter adesão à organização

CALENDLY_GET_ORGANIZATION_MEMBERSHIP

Recupera uma adesão específica à organização Calendly pelo seu UUID, retornando todos os seus atributos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
uuid	string	Sim	O identificador único (UUID) da adesão à organização a recuperar.

Saí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.

Obter formulário de roteamento

CALENDLY_GET_ROUTING_FORM

Recupera um formulário de roteamento específico pelo seu UUID, fornecendo seus detalhes de configuração incluindo perguntas e lógica de roteamento.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
uuid	string	Sim	O identificador único (UUID) do formulário de roteamento a recuperar.

Saí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.

Obter submissão de formulário de roteamento

CALENDLY_GET_ROUTING_FORM_SUBMISSION

Recupera detalhes sobre uma submissão específica de formulário de roteamento pelo seu UUID. Use quando precisar de detalhes da submissão incluindo perguntas, respostas e resultados de roteamento.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
uuid	string	Sim	O identificador único (UUID) da submissão de formulário de roteamento a recuperar. Extraia do URI da submissão ou do payload do webhook.

Saí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.

Obter dados de webhook de exemplo

CALENDLY_GET_SAMPLE_WEBHOOK_DATA

Recupera dados de payload de webhook de exemplo para testar assinaturas de webhook. Use quando precisar verificar a configuração do webhook e entender a estrutura dos dados antes de criar assinaturas de webhook reais.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user	string	Não	URI do usuário para recuperar dados de webhook de exemplo. Obrigatório quando o escopo é 'user'. Formato: https://api.calendly.com/users/{user_uuid}.
event	string	Sim	Tipo de evento de webhook para recuperar dados de exemplo. Valores válidos: 'invitee.created', 'invitee.canceled', 'routing_form_submission.created'.
scope	string	Sim	Nível de escopo para os dados de webhook. Valores válidos: 'user' ou 'organization'. Eventos routing_form_submission.created exigem escopo 'organization'.
organization	string	Sim	URI da organização para recuperar dados de webhook de exemplo. Este parâmetro é sempre obrigatório. Formato: https://api.calendly.com/organizations/{organization_uuid}.

Saí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.

Obter usuário

CALENDLY_GET_USER

Recupera informações abrangentes de um usuário Calendly existente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
uuid	string	Não	O identificador único (UUID) do usuário. Como alternativa, use a string literal "me" para se referir ao usuário atualmente autenticado. Padrão: "me" (usuário atual) se não especificado.

Saí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.

Obter agenda de disponibilidade do usuário

CALENDLY_GET_USER_AVAILABILITY_SCHEDULE

Recupera uma agenda de disponibilidade de usuário existente pelo seu UUID; essa agenda define os horários padrão de disponibilidade do usuário.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
uuid	string	Sim	Identificador único (UUID) da agenda de disponibilidade.

Saí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.

Obter assinatura de webhook

CALENDLY_GET_WEBHOOK_SUBSCRIPTION

Recupera os detalhes de uma assinatura de webhook existente, identificada pelo seu UUID, incluindo a URL de callback, eventos assinados, escopo e estado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
webhook_uuid	string	Sim	Identificador único (UUID) da assinatura de webhook a recuperar.

Saí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.

Marcar convidado como ausente

CALENDLY_INVITEE_NO_SHOW

Marca um convidado como ausente em um evento agendado. Use quando um convidado não comparecer à reunião agendada e precisar registrar a ausência no Calendly.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
invitee	string	Sim	URI do convidado a ser marcado como ausente. Deve ser um URI válido referenciando um convidado existente de um evento agendado (ex.: 'https://api.calendly.com/scheduled_events/GBGBDCAADAEDCRZ2/invitees/AAAAAAAAAAAAAAAA').

Saí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.

Listar entradas do log de atividades

CALENDLY_LIST_ACTIVITY_LOG_ENTRIES

Recupera uma lista de entradas do log de atividades para uma organização Calendly especificada (requer assinatura Enterprise ativa), com suporte a filtragem, ordenação e paginação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
sort	array	Não	Especifica a ordem de classificação dos resultados. Forneça uma lista de strings de critérios de ordenação, cada uma no formato 'campo:direção' (ex.: 'occurred_at:asc').
actor	array	Não	Filtra entradas do log de atividades pelos usuários que realizaram as ações. Forneça uma lista de URIs de usuários.
count	integer	Não	Número máximo de entradas do log de atividades a retornar por página.
action	array	Não	Filtra entradas pela ação específica realizada (ex.: 'user.created', 'event_type.updated'). Forneça uma lista de strings de ação.
namespace	array	Não	Filtra entradas por categoria ou domínio (namespace). Exemplos: 'user_management' ou 'event_type_management'.
page_token	string	Não	Token para paginação, usado para buscar a próxima página de resultados.
search_term	string	Não	Filtra entradas com base no termo de busca. Operadores suportados: | (OU), + (E), " " (frase exata), - (excluir), () (precedência), * (prefixo).
organization	string	Sim	URI da organização Calendly para a qual recuperar entradas do log de atividades.
max_occurred_at	string	Não	Timestamp em formato ISO 8601 UTC. Filtra entradas ocorridas antes ou neste horário.
min_occurred_at	string	Não	Timestamp em formato ISO 8601 UTC. Filtra entradas ocorridas depois ou neste horário.

Saí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.

Listar convidados do evento

CALENDLY_LIST_EVENT_INVITEES

Recupera uma lista de convidados de um evento Calendly específico pelo UUID, com opções para filtrar por status ou e-mail e ordenar por data de criação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
sort	string	Não	Ordena resultados pelo campo created_at; use 'created_at:asc' para crescente ou 'created_at:desc' para decrescente.
uuid	string	Sim	O identificador único (UUID) do evento para o qual listar convidados.
count	integer	Não	Número de convidados a retornar por página. Padrão: 20.
email	string	Não	Filtra resultados pelo endereço de e-mail de um convidado específico.
status	string	Não	Filtra convidados por status. Pode ser 'active' ou 'canceled'.
page_token	string	Não	Token para recuperar a próxima ou anterior página de resultados em uma coleção paginada.

Saí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.

Listar eventos (Descontinuado)

CALENDLY_LIST_EVENTS

DESCONTINUADO: Use CALENDLY_LIST_SCHEDULED_EVENTS em vez desta ação. Recupera uma lista de eventos Calendly agendados. Exatamente um entre user, organization ou group deve ser fornecido para delimitar a consulta.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
sort	string	Não	Ordem de classificação dos resultados. Aceita valores campo:direção separados por vírgula. Campo suportado: start_time. Direções: asc, desc.
user	string	Não	URI completo da API Calendly do usuário cujos eventos listar. Deve estar no formato 'https://api.calendly.com/users/{uuid}'. O atalho 'me' não é suportado — use CALENDLY_GET_CURRENT_USER primeiro. Exatamente UM entre user, organization ou group deve ser fornecido.
count	integer	Não	Número de eventos a retornar por página.
group	string	Não	URI completo da API Calendly do grupo cujos eventos listar. Formato: 'https://api.calendly.com/groups/{uuid}'. Exatamente UM entre user, organization ou group deve ser fornecido.
status	string	Não	Filtra eventos por status. 'active' ou 'canceled'.
page_token	string	Não	Token para paginação.
organization	string	Não	URI completo da organização. Formato: 'https://api.calendly.com/organizations/{uuid}'. Privilégios de administrador podem ser necessários.
invitee_email	string	Não	E-mail do convidado para filtrar eventos. É um parâmetro de filtro; exige que um dos escopos (user, organization ou group) seja fornecido.
max_start_time	string	Não	Inclui eventos com horário de início anterior ou igual a este timestamp UTC (ex.: '2020-01-02T03:04:05.678123Z').
min_start_time	string	Não	Inclui eventos com horário de início posterior ou igual a este timestamp UTC (ex.: '2020-01-02T03:04:05.678123Z').

Saí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.

Listar horários disponíveis do tipo de evento

CALENDLY_LIST_EVENT_TYPE_AVAILABLE_TIMES

Busca horários disponíveis para um tipo de evento Calendly dentro de um intervalo de tempo especificado; os resultados não são paginados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
end_time	string	Sim	Data e hora de fim (exclusivo) do intervalo de disponibilidade solicitado, em formato UTC ISO 8601 (ex.: 'YYYY-MM-DDTHH:MM:SSZ'). A duração entre start_time e end_time não pode exceder 7 dias.
event_type	string	Sim	URI do tipo de evento para o qual encontrar horários disponíveis.
start_time	string	Sim	Data e hora de início (inclusivo) do intervalo de disponibilidade solicitado, em formato UTC ISO 8601. Deve ser no futuro.

Saí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.

Listar anfitriões do tipo de evento

CALENDLY_LIST_EVENT_TYPE_MEMBERSHIPS

Recupera uma lista de anfitriões (membros) de um tipo de evento específico. Use quando precisar ver quais usuários estão configurados como anfitriões de um tipo de evento.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
count	integer	Não	Número de resultados a retornar por página. Deve ser um inteiro positivo.
event_type	string	Sim	URI do tipo de evento para recuperar membros. Formato: 'https://api.calendly.com/event_types/{uuid}'. Passe o URI completo, não apenas o UUID.
page_token	string	Não	Token de paginação para recuperar uma página específica de resultados.

Saí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.

Listar tipos de evento

CALENDLY_LIST_EVENT_TYPES

Lista todos os tipos de evento associados a um usuário ou organização especificados. Use quando precisar recuperar tipos de evento para um usuário ou organização. Use scheduling_url dos resultados diretamente; não construa URLs de tipo de evento manualmente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
sort	string	Não	Ordena resultados por campo(s) e direção. Aceita lista separada por vírgula de valores campo:direção (ex.: 'name:asc,created_at:desc'). Padrão: name:asc.
user	string	Não	URI do usuário cujos tipos de evento listar. Exatamente um entre 'user' ou 'organization' deve ser fornecido (mutuamente exclusivos).
count	integer	Não	Número de resultados por página.
active	boolean	Não	Filtra por status ativo. Retorna apenas tipos ativos se verdadeiro, apenas inativos se falso, ou todos se omitido.
page_token	string	Não	Token de paginação para recuperar páginas subsequentes.
organization	string	Não	URI da organização cujos tipos de evento listar. Exatamente um entre 'organization' ou 'user' deve ser fornecido (mutuamente exclusivos).
admin_managed	boolean	Não	Filtra por status de gerenciamento por administrador.
user_availability_schedule	string	Não	URI da agenda de disponibilidade do usuário. Usado com 'user' para filtrar tipos de evento por agenda de disponibilidade principal.

Saí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.

Listar relacionamentos de grupo

CALENDLY_LIST_GROUP_RELATIONSHIPS

Recupera uma lista de relacionamentos de grupo que definem o papel do proprietário (ex.: membro, administrador) dentro de um grupo; um proprietário pode ter uma adesão por grupo, mas vários papéis de administrador em diferentes grupos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
count	integer	Não	Número de registros por página (máximo 100).
group	string	Não	Filtra resultados por URI de grupo.
owner	string	Não	Filtra resultados por URI de proprietário (URI de Membro de Organização ou de Convite).
page_token	string	Não	Token para recuperar uma página específica de resultados.
organization	string	Não	Filtra resultados por URI de organização.

Saí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.

Listar grupos

CALENDLY_LIST_GROUPS

Retorna uma lista de grupos para um URI de organização Calendly especificado, com suporte a paginação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
count	integer	Não	Número máximo de grupos a retornar por página. O valor pode variar de 1 a 100.
page_token	string	Não	Token para recuperar uma página específica de resultados. Passe o valor de 'next_page_token' de uma resposta anterior.
organization	string	Sim	URI da organização para filtrar grupos. Exemplo: 'https://api.calendly.com/organizations/ORGANIZATION_UUID'.

Saí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.

Listar convites da organização

CALENDLY_LIST_ORGANIZATION_INVITATIONS

Recupera uma lista de convites para uma organização específica, identificada pelo seu UUID.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
sort	string	Não	Ordem dos resultados por campo(s) e direção (asc/desc); ex.: 'created_at:asc' ou 'email:desc,status:asc'.
uuid	string	Sim	Identificador único (UUID) da organização.
count	integer	Não	Número de resultados a retornar por página.
email	string	Não	Filtra pelo endereço de e-mail do destinatário.
status	string	Não	Filtra por status do convite: 'pending', 'accepted' ou 'declined'.
page_token	string	Não	Token de paginação para acessar uma página específica de resultados.

Saí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.

Listar membros da organização

CALENDLY_LIST_ORGANIZATION_MEMBERSHIPS

Recupera uma lista de membros da organização.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user	string	Não	Filtra membros pelo URI do usuário. Pelo menos um entre 'organization' ou 'user' é obrigatório.
count	integer	Não	Número de registros de adesão a retornar por página. Deve ser um inteiro entre 1 e 100.
email	string	Não	Filtra membros pelo endereço de e-mail do usuário. Deve ser usado com 'organization' ou 'user'.
page_token	string	Não	Token para recuperar a próxima ou anterior página de resultados em uma coleção paginada.
organization	string	Não	Filtra membros pelo URI da organização. Pelo menos um entre 'organization' ou 'user' é obrigatório.

Saí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.

Listar comunicações enviadas

CALENDLY_LIST_OUTGOING_COMMUNICATIONS

Recupera uma lista de comunicações SMS enviadas para uma organização especificada; requer assinatura Enterprise e, se filtrar por data de criação, tanto min_created_at quanto max_created_at devem ser fornecidos para formar um intervalo válido.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
count	integer	Não	Número de registros a retornar por página. Deve ser entre 1 e 100.
page_token	string	Não	Token para recuperar a próxima página de resultados.
organization	string	Sim	URI da organização cujas comunicações enviadas serão recuperadas.
max_created_at	string	Não	Inclui comunicações criadas antes deste timestamp. Formato: "YYYY-MM-DDTHH:MM:SS.sssZ" em UTC.
min_created_at	string	Não	Inclui comunicações criadas depois deste timestamp. Formato: "YYYY-MM-DDTHH:MM:SS.sssZ" em UTC.

Saí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.

Listar formulários de roteamento

CALENDLY_LIST_ROUTING_FORMS

Recupera formulários de roteamento para uma organização especificada; formulários de roteamento são questionários usados para direcionar convidados a páginas de reserva apropriadas ou URLs externas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
sort	string	Não	Especifica a ordem dos resultados. Use uma lista separada por vírgula de pares campo:direção. Campo suportado: created_at. Direções: asc, desc.
count	integer	Não	Número de formulários de roteamento a retornar por página.
page_token	string	Não	Token para recuperar uma página específica de resultados.
organization	string	Sim	URI da organização para a qual recuperar formulários de roteamento.

Saí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.

Listar eventos agendados

CALENDLY_LIST_SCHEDULED_EVENTS

Recupera uma lista de eventos Calendly agendados. Use quando precisar visualizar eventos de um usuário, organização ou grupo específico. Requer exatamente um entre os parâmetros user, organization ou group para delimitar a consulta.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
sort	string	Não	Ordena resultados pelo campo e direção especificados. Formato: 'campo:direção'. Campo suportado: 'start_time'. Direções: 'asc', 'desc'.
user	string	Não	URI completo da API Calendly do usuário. Formato: 'https://api.calendly.com/users/{uuid}'. O atalho 'me' não é suportado. Exatamente UM entre user, organization ou group deve ser fornecido.
count	integer	Não	Número de eventos a retornar por página. Deve ser um inteiro positivo.
group	string	Não	URI completo da API Calendly do grupo. Formato: 'https://api.calendly.com/groups/{uuid}'. Exatamente UM entre user, organization ou group deve ser fornecido.
status	string	Não	Filtra eventos por status. 'active' para eventos ativos ou 'canceled' para cancelados.
page_token	string	Não	Token de paginação para recuperar uma página específica de resultados.
organization	string	Não	URI completo da organização. Formato: 'https://api.calendly.com/organizations/{uuid}'. Privilégios de administrador podem ser necessários.
invitee_email	string	Não	Retorna eventos agendados com o convidado associado a este e-mail. É um parâmetro de filtro e deve ser usado com um dos parâmetros de escopo.
max_start_time	string	Não	Inclui eventos com horário de início anterior a este horário. Deve estar em formato UTC (ISO 8601).
min_start_time	string	Não	Inclui eventos com horário de início posterior a este horário. Deve estar em formato UTC (ISO 8601).

Saí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.

Listar agendas de disponibilidade do usuário

CALENDLY_LIST_USER_AVAILABILITY_SCHEDULES

Recupera todas as agendas de disponibilidade para o usuário Calendly especificado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user	string	Sim	URI do usuário cujas agendas de disponibilidade serão listadas; deve ser um URI de usuário Calendly válido.

Saí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.

Listar horários ocupados do usuário

CALENDLY_LIST_USER_BUSY_TIMES

Busca os intervalos de horário ocupado de um usuário (eventos de calendários internos e externos) em ordem crescente para um período de até 7 dias; paginação por keyset não é suportada.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user	string	Sim	URI do usuário cujos horários ocupados estão sendo consultados. Tipicamente é o URI da API Calendly do usuário.
end_time	string	Sim	Fim do intervalo de tempo para buscar horários ocupados, em formato RFC3339 (ex.: '2023-10-26T11:00:00Z'). Deve ser posterior a start_time.
start_time	string	Sim	Início do intervalo de tempo para buscar horários ocupados, em formato RFC3339 (ex.: '2023-10-26T10:00:00Z').

Saí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.

Listar locais de reunião do usuário

CALENDLY_LIST_USER_LOCATIONS

Recupera informações de locais de reunião configurados para um usuário Calendly específico. Use quando precisar ver todas as opções de local disponíveis configuradas pelo usuário para suas reuniões.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user	string	Sim	URI do usuário cujos locais listar. Deve ser o URI completo do usuário Calendly (ex.: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA').

Saí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.

Listar tipos de evento do usuário (Descontinuado)

CALENDLY_LIST_USER_S_EVENT_TYPES

DESCONTINUADO: Use CALENDLY_LIST_EVENT_TYPES em vez desta ação. Recupera tipos de evento para um usuário ou organização; requer o URI de user ou organization.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
sort	string	Não	Ordena resultados por campo(s) e direção ('asc' ou 'desc'). Campos suportados: name, position, created_at, updated_at. Padrão: 'name:asc'.
user	string	Não	URI do usuário cujos tipos de evento listar. Forneça user OU organization (exatamente um obrigatório). IMPORTANTE: Deve ser o URI real do usuário (ex.: https://api.calendly.com/users/5dc7b7a8-1d8c-4fcc-8b63-5f5a17eea4a3). O atalho 'https://api.calendly.com/users/me' não é aceito — use a ação ‘Get Current User’ primeiro.
count	integer	Não	Número de tipos de evento por página (máximo 100).
active	boolean	Não	Filtra por status ativo (true para ativos, false para inativos). Se omitido, todos são retornados.
page_token	string	Não	Token para recuperar a próxima ou anterior página de tipos de evento.
organization	string	Não	URI da organização cujos tipos de evento listar. Forneça organization OU user (exatamente um obrigatório).
admin_managed	boolean	Não	Filtra por gerenciamento de administrador.
user_availability_schedule	string	Não	URI da agenda de disponibilidade do usuário. Exemplo: 'https://api.calendly.com/user_availability_schedules/SCHEDULE_UUID'.

Saí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.

Listar assinaturas de webhook

CALENDLY_LIST_WEBHOOK_SUBSCRIPTIONS

Recupera assinaturas de webhook para uma organização Calendly; scope determina se o URI de user ou group também é necessário para filtragem.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
sort	string	Não	Ordem de classificação dos resultados (ex.: 'created_at:asc'). Campos suportados: created_at, updated_at. Direções: asc, desc.
user	string	Não	URI do usuário Calendly; obrigatório se scope for 'user'.
count	integer	Não	Número de resultados por página (máximo 100).
group	string	Não	URI do grupo Calendly; obrigatório se scope for 'group'.
scope	string	Sim	Escopo das assinaturas de webhook: 'organization', 'user' ou 'group'.
page_token	string	Não	Token para paginar para a próxima ou anterior página de resultados.
organization	string	Sim	URI da organização Calendly para a qual listar assinaturas de webhook.

Saí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.

Convidar usuário para a organização

CALENDLY_ORGANIZATION_INVITATION

Convida um usuário para uma organização Calendly por e-mail. Use quando precisar enviar um convite de organização para um novo usuário. Requer privilégios de proprietário ou administrador da organização.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
email	string	Sim	Endereço de e-mail do usuário a convidar para a organização. Um e-mail de convite será enviado automaticamente para este endereço.
org_uuid	string	Sim	O identificador único (UUID) da organização para a qual convidar o usuário.

Saí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.

Criar convidado de evento

CALENDLY_POST_INVITEE

Cria um novo convidado de evento com notificações padrão, convites de calendário, reagendamentos e fluxos de trabalho. Use para agendar reuniões programaticamente via API. Requer plano Calendly pago (Standard+).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
invitee	object	Sim	Detalhes do convidado a ser agendado.
location	object	Não	Configuração do local da reunião.
tracking	object	Não	Parâmetros UTM e de rastreamento para atribuição de marketing.
event_type	string	Sim	Referência URI ao tipo de evento a agendar (ex.: 'https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA').
start_time	string	Sim	Horário de início do evento agendado em formato ISO 8601 UTC (ex.: '2025-12-16T10:00:00Z').
event_guests	array	Não	Lista de endereços de e-mail para convidados adicionais (máximo 10).
questions_and_answers	array	Não	Respostas a perguntas personalizadas do formulário de reserva.

Saí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.

Remover usuário da organização

CALENDLY_REMOVE_USER_FROM_ORGANIZATION

Remove um usuário (que não seja proprietário) de uma organização pelo UUID de adesão, requerendo privilégios administrativos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
uuid	string	Sim	UUID da adesão à organização a remover. É o identificador único do URI de adesão (ex.: de 'https://api.calendly.com/organization_memberships/UUID'). Obtenha os UUIDs de adesão chamando list_organization_memberships. Não é possível remover proprietários de organização — use apenas para papéis de administrador ou usuário.

Saí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.

Revogar convite de organização do usuário

CALENDLY_REVOKE_USER_S_ORGANIZATION_INVITATION

Revoga um convite de organização pendente e revogável (ainda não aceito ou expirado) usando o UUID do convite e o UUID da organização, tornando o link de convite inválido.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
uuid	string	Sim	O identificador único do convite de organização a ser revogado.
org_uuid	string	Sim	O identificador único da organização.

Saí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.

Atualizar tipo de evento

CALENDLY_UPDATE_EVENT_TYPE

Atualiza um tipo de evento individual (kind: solo) existente no Calendly. Use quando precisar modificar configurações do tipo de evento como nome, duração, local ou descrição. NOTA: Atualmente suporta apenas tipos de evento individuais.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Não	O nome do tipo de evento que será exibido aos convidados.
uuid	string	Sim	Identificador único (UUID) do tipo de evento a atualizar. Pode ser fornecido como URI completo (ex.: 'https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA') ou apenas o UUID (ex.: 'AAAAAAAAAAAAAAAA').
color	string	Não	Valor de cor hexadecimal para a página de agendamento. Deve corresponder ao padrão ^#[a-f\d]{6}$ (ex.: '#fff200').
active	boolean	Não	Indica se o tipo de evento está ativo e disponível para reserva.
locale	string	Não	Idioma para a página de agendamento do tipo de evento. Opções: "de", "en", "es", "fr", "it", "nl", "pt", "uk".
duration	integer	Não	Duração das sessões em minutos. Deve ser entre 1 e 720 minutos.
locations	array	Não	Informações de configuração para cada possível local onde o evento pode ocorrer.
description	string	Não	Descrição do tipo de evento exibida na página de agendamento (formato texto simples).
duration_options	array	Não	Opções de duração alternativas para reuniões flexíveis. Máximo de 4 valores únicos entre 1 e 720 minutos.

Saí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.

Atualizar disponibilidade do tipo de evento

CALENDLY_UPDATE_EVENT_TYPE_AVAILABILITY

Atualiza uma agenda de disponibilidade de tipo de evento no Calendly. Use quando precisar alterar o fuso horário ou regras de disponibilidade de um tipo de evento. AVISO: Atualizar as regras substituirá todas as regras existentes — recupere as regras existentes primeiro usando GET /event_type_availability_schedules.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user	string	Não	URI do usuário associado ao tipo de evento. Obrigatório quando um administrador ou proprietário de organização estiver atualizando a agenda de um usuário específico.
event_type	string	Sim	URI do tipo de evento cuja agenda de disponibilidade será atualizada. Deve seguir o padrão https://api.calendly.com/event_types/{uuid}. Outros URIs do Calendly (ex.: user_availability_schedules, scheduling_links, users) não são válidos para este campo.
availability_rule	object	Sim	Configuração da regra de disponibilidade contendo fuso horário e regras de quando o tipo de evento está disponível. AVISO: As regras substituirão todas as regras existentes.
availability_setting	string	Não	Indica como a disponibilidade é determinada. Padrão: 'host'. Cada anfitrião no tipo de evento compartilha a mesma agenda.

Saí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.