Référence de l'API
Toutes les routes de l'API publique d'Artibox Calendar : portées, paramètres, exemples de requêtes et de réponses, erreurs.
- Adresse de base
- https://www.artibox-calendar.com/api/v1
- Version 1.0.0
- Description OpenAPI 3.1 (JSON)
Authentification
Envoyez un jeton personnel (rdv_pat_…) ou un jeton d'accès OAuth (rdv_oat_…) dans l'en-tête x-api-key. Chaque route demande une portée.
curl 'https://www.artibox-calendar.com/api/v1/me/context' \
-H "x-api-key: $RDV_TOKEN"Portées
| Portée | Description |
|---|---|
utilisateur:lire | Lire le compte du jeton, son contexte et ses notifications |
organisation:lire | Lire l'organisation, ses réglages et ses membres |
organisation:administrer | Modifier l'organisation, ses réglages, ses membres et ses formulaires d'orientation |
types:lire | Lire les types de rendez-vous, leurs créneaux et leurs messages |
types:ecrire | Créer, modifier et supprimer les types de rendez-vous |
disponibilites:lire | Lire les plannings, les exceptions, les heures occupées et l'aperçu des disponibilités |
disponibilites:ecrire | Créer, modifier et supprimer les plannings et les exceptions |
reservations:lire | Lire les rendez-vous et les sondages |
reservations:ecrire | Créer, déplacer, annuler et constater les rendez-vous ; gérer les sondages |
liens:ecrire | Créer des liens uniques, des liens signés et des envois de lien |
webhooks:ecrire | Gérer les abonnements aux webhooks et rejouer les livraisons |
journal:lire | Lire le journal d'audit de l'organisation |
donnees:effacer | Exporter et effacer les données personnelles d'un invité (RGPD) |
Limites
100 appels par minute et par jeton. Chaque réponse porte X-RateLimit-Limit, X-RateLimit-Remaining et X-RateLimit-Reset ; au-delà, 429 et Retry-After.
Erreurs
| HTTP | Description |
|---|---|
401 | Jeton absent, inconnu ou expiré |
403 | Portée manquante ou droit refusé |
404 | Introuvable (ou d'une autre organisation) |
409 | Conflit : créneau pris ou requête en cours |
422 | Données refusées : le détail est donné champ par champ |
429 | Trop d'appels : attendez Retry-After |
{
"message": "error",
"data": null,
"errors": {
"error": "…",
"validation": {
"start": [
"…"
]
}
}
}Compte et contexte
Le compte du jeton, son organisation, ses droits et ses notifications.
4 routes
Types de rendez-vous
Les types de rendez-vous de l'organisation, leurs réglages et leurs créneaux.
9 routes
/typesLister les types de rendez-vous/typesCréer un type de rendez-vous/types/templatesLister les modèles de types proposés à la création/types/slug-checkVérifier qu'une adresse de type est libre/types/slot-previewPrévisualiser les créneaux de réglages non enregistrés/types/{id}Lire un type de rendez-vous/types/{id}Modifier un type de rendez-vous/types/{id}Supprimer un type de rendez-vous/types/{id}/slotsTrouver les créneaux libres d'un type
Disponibilités
Les plannings, les exceptions et l'aperçu des heures libres des membres.
12 routes
/schedulesLister les plannings/schedulesCréer un planning (vide ou copié)/schedules/{id}Renommer un planning/schedules/{id}Supprimer un planning/schedules/{id}/defaultFaire d'un planning celui par défaut/schedules/{id}/weekly-hoursRégler la semaine type d'un planning/exceptionsLister les exceptions (congés, heures en plus)/exceptionsAjouter une exception (absence ou heures en plus)/exceptions/{id}Modifier une exception/exceptions/{id}Supprimer une exception/availability/previewAperçu des disponibilités d'un membre/busy-timesLire les heures occupées d'un membre (31 jours au plus)
Rendez-vous
Créer, lire, déplacer, annuler et constater les rendez-vous.
9 routes
/bookingsLister les rendez-vous/bookingsRéserver un créneau/bookings/{id}Lire un rendez-vous/bookings/{id}/sendsLister les messages envoyés ou prévus pour un rendez-vous/bookings/{id}/sessionLire la séance d'un rendez-vous de groupe et ses inscrits/bookings/{id}/cancelAnnuler un rendez-vous/bookings/{id}/moveDéplacer un rendez-vous/bookings/{id}/observeConstater un rendez-vous (honoré, absent)/bookings/{id}/crmLire les synchronisations CRM d'un rendez-vous
Réunions ponctuelles
Des rendez-vous à créneaux choisis, proposés une fois à un invité.
4 routes
Liens uniques et liens signés
Les liens de réservation à usage unique et les liens signés avec contexte (11.8).
4 routes
Envoi du lien
Envoyer le lien d'un type par courriel ou SMS, et le relancer.
3 routes
Messages par type
Les messages envoyés aux invités d'un type (confirmation, rappel…).
3 routes
Sondages de dates
Proposer des dates, suivre les votes, confirmer une date.
5 routes
Organisation
L'organisation, ses réglages, ses membres, son domaine et sa clé de contexte.
20 routes
/organization/context-keyLire la date de la clé de contexte/organization/context-keyGénérer une nouvelle clé de contexte/organization/domainLire le domaine personnalisé/organization/domainDéclarer un domaine personnalisé/organization/domainRetirer le domaine personnalisé/organization/domain/verifyVérifier le domaine personnalisé/membersLister les membres/members/{id}Lire un membre/members/{id}Modifier un membre (rôle, activité)/invitationsLister les invitations/invitationsInviter une personne dans l'organisation/invitations/{id}Annuler une invitation/organizationLire l'organisation/organizationModifier l'organisation/organization/logoLire le logo de l'organisation/organization/logoEnvoyer le logo de l'organisation/settingsLire les délais et limites/settingsModifier les délais et limites/settings/historyLire l'historique des réglages/auditLire le journal d'audit
Formulaires d'orientation
Les formulaires qui orientent un invité vers le bon type ou la bonne personne.
7 routes
/orientation-formsLister les formulaires d'orientation/orientation-formsCréer un formulaire d'orientation/orientation-forms/{id}/submissionsLister les réponses à un formulaire d'orientation/orientation-submissions/{id}Lire une réponse à un formulaire d'orientation/orientation-forms/{id}Lire un formulaire d'orientation/orientation-forms/{id}Modifier un formulaire d'orientation/orientation-forms/{id}Supprimer un formulaire d'orientation
Webhooks
Les abonnements aux événements, leurs livraisons et leur test.
8 routes
/webhook-subscriptionsLister les abonnements aux webhooks/webhook-subscriptionsS'abonner à des événements/webhook-subscriptions/{id}Lire un abonnement/webhook-subscriptions/{id}Modifier un abonnement/webhook-subscriptions/{id}Supprimer un abonnement/webhook-subscriptions/{id}/deliveriesLister les livraisons d'un abonnement (30 jours)/webhook-subscriptions/{id}/testEnvoyer un événement de test/webhook-deliveries/{id}/replayRejouer une livraison
Données personnelles
Exporter et effacer les données d'un invité (RGPD).
3 routes
Serveur OAuth
Échanger un code, rafraîchir, révoquer et inspecter les jetons d'une application OAuth.
3 routes
Serveur MCP
Le point d'entrée MCP pour les assistants et agents IA.
3 routes