Obter agendamento no Acuity Scheduling, por uma API
Retorna um agendamento, com nome, e-mail e telefone do cliente, datetime, endTime, type, calendar, price, paid, notes, as respostas do formulário de entrada em forms, labels e confirmationPage. Um agendamento cancelado também tem noShow.
- Identificador
- acuity_get_appointment
A chamada
POST https://connect.reportei.com/api/tools/acuity_get_appointment/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"id": 1
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| id | integer | Sim | Id of the appointment: the id from List appointments or Create appointment. |
| pastFormAnswers | boolean | Não | true to also return the previous answers given to the intake forms of the appointment. |
Conexões possíveis
O seu cliente conecta a conta do Acuity Scheduling uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Usuário e senha
O cliente informa as credenciais do app numa tela do Connect, ou o seu sistema as envia por POST /api/customer-toolkits, sem tela.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/acuity_get_appointment. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Acuity Scheduling
- Listar agendamentosGETLista os agendamentos da conta, do mais recente ao mais antigo por padrão, até max por chamada. Não há token de página: quando uma chamada retorna max agendamentos, restrinja minDate e maxDate. Agendamentos cancelados só vêm com canceled ou showall.
- Criar agendamentoPOSTAgenda um atendimento e o retorna. Por padrão ele é agendado como um cliente faria: o horário precisa estar livre e os campos obrigatórios do formulário respondidos. Com admin true essas verificações são ignoradas e calendarID é obrigatório. O cliente recebe o e-mail e o SMS de confirmação, a menos que noEmail seja true.
- Atualizar agendamentoPUTAtualiza os dados do cliente, as respostas do formulário ou as notas de um agendamento e o retorna. Só os campos enviados mudam, e firstName e lastName não podem ser apagados. Data, horário e calendário mudam com Reschedule appointment.
- Cancelar agendamentoPUTCancela um agendamento e o retorna. Um agendamento cancelado não pode ser restaurado. Por padrão valem as regras de cancelamento dos clientes; com admin true elas são ignoradas e noShow pode ser definido. O cliente recebe o e-mail e o SMS de cancelamento, a menos que noEmail seja true.
- Remarcar agendamentoPUTMove um agendamento para outra data e horário, outro calendário ou ambos, e o retorna. O novo horário precisa estar livre, a menos que admin seja true. Agendamentos cancelados e séries de aulas não podem ser remarcados. O cliente recebe o e-mail e o SMS de remarcação, a menos que noEmail seja true.
- Listar tipos de atendimentoGETLista os tipos de atendimento, os serviços e as aulas que os clientes agendam, com id, name, duração em minutos, price, type (service, class ou series), private e calendarIDs, os calendários que oferecem cada um.
- Listar calendáriosGETLista os calendários que a conta pode acessar, em geral um por membro da equipe, com id, name, email, location e timezone.
- Listar datas disponíveisGETLista as datas de um mês que têm horários livres para um tipo de atendimento, as mesmas datas que a página de agendamento do cliente mostra. Cada item tem date.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
