Lister les clients avec l'API Acuity Scheduling
Liste les clients du compte, avec firstName, lastName, email, phone et notes.
- Identifiant
- acuity_list_clients
L'appel
POST https://connect.reportei.com/api/tools/acuity_list_clients/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"search": "<search>"
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| search | string | Non | Text to look for in the first name, last name or phone number of the clients. |
Connexions possibles
Votre client connecte son compte Acuity Scheduling une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
Identifiant et mot de passe
Votre client saisit les identifiants de l'app sur un écran de Connect, ou votre système les envoie avec POST /api/customer-toolkits, sans écran.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/acuity_list_clients. Il devient la définition de tool de votre agent sans conversion.
Autres tools Acuity Scheduling
- Lister les rendez-vousGETListe les rendez-vous du compte, du plus récent au plus ancien par défaut, jusqu'à max par appel. Il n'y a pas de jeton de page : quand un appel renvoie max rendez-vous, restreignez minDate et maxDate. Les rendez-vous annulés ne viennent qu'avec canceled ou showall.
- Obtenir un rendez-vousGETRenvoie un rendez-vous, avec le nom, l'e-mail et le téléphone du client, datetime, endTime, type, calendar, price, paid, notes, les réponses du formulaire d'accueil dans forms, labels et confirmationPage. Un rendez-vous annulé a aussi noShow.
- Créer un rendez-vousPOSTRéserve un rendez-vous et le renvoie. Par défaut, il est réservé comme le ferait un client : le créneau doit être libre et les champs obligatoires du formulaire remplis. Avec admin true, ces vérifications sont ignorées et calendarID est obligatoire. Le client reçoit l'e-mail et le SMS de confirmation, sauf si noEmail est true.
- Mettre à jour un rendez-vousPUTMet à jour les informations du client, les réponses du formulaire ou les notes d'un rendez-vous et le renvoie. Seuls les champs envoyés changent, et firstName et lastName ne peuvent pas être effacés. La date, l'heure et l'agenda changent avec Reschedule appointment.
- Annuler un rendez-vousPUTAnnule un rendez-vous et le renvoie. Un rendez-vous annulé ne peut pas être rétabli. Par défaut, les règles d'annulation des clients s'appliquent ; avec admin true, elles sont ignorées et noShow peut être défini. Le client reçoit l'e-mail et le SMS d'annulation, sauf si noEmail est true.
- Reporter un rendez-vousPUTDéplace un rendez-vous vers une autre date et heure, un autre agenda ou les deux, et le renvoie. Le nouveau créneau doit être libre, sauf si admin est true. Les rendez-vous annulés et les séries de cours ne peuvent pas être reportés. Le client reçoit l'e-mail et le SMS de report, sauf si noEmail est true.
- Lister les types de rendez-vousGETListe les types de rendez-vous, les services et les cours que réservent les clients, avec id, name, durée en minutes, price, type (service, class ou series), private et calendarIDs, les agendas qui proposent chacun.
- Lister les agendasGETListe les agendas auxquels le compte a accès, généralement un par membre de l'équipe, avec id, name, email, location et timezone.
Toolkits de la même catégorie
Voir les 100 toolkitsVoyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
