Passer au contenu principal
GET
Renvoie les heures de début des créneaux réservables pour un seul lieu sur la période demandée. Les créneaux sont générés à partir de open_hours du lieu, en excluant les dates bloquées globales ou propres au lieu et en soustrayant les rendez-vous Aniva déjà réservés, afin que le résultat reflète ce que tes patients peuvent réellement réserver côté client. Nécessite le scope appointments_schedule. Le lieu doit également relever du contexte d’accès par groupe de lieux de ta clé API.
Utilise cet endpoint plutôt que de déduire les disponibilités à partir des horaires statiques open_hours renvoyés par Lister les lieux — seul cet endpoint tient compte des réservations en temps réel, des exceptions d’horaires par date et du préavis minimum de 12 heures dans les lieux gérés par Aniva. Chaque créneau renvoyé ici est réservable tel quel.
Les réponses incluent Cache-Control: private, max-age=30, stale-while-revalidate=60, donc un navigateur peut servir une réponse en cache pendant jusqu’à ~30 secondes — un créneau réservé dans cet intervalle peut encore apparaître comme réservable jusqu’au prochain rafraîchissement. Fais aussi remonter les conflits au moment de la réservation.

Paramètres de chemin

string
requis
Identifiant du lieu (UUID). Utilise l’id issu de Lister les lieux.

Paramètres de requête

string
Début inclusif de la période au format YYYY-MM-DD (interprété dans timezone). Facultatif. Prend par défaut aujourd’hui si aucune date n’est fournie, ou end_date − 30 days si seule end_date est fournie. Les dates passées sont automatiquement ramenées à aujourd’hui.
string
Fin inclusive de la période au format YYYY-MM-DD (interprétée dans timezone). Facultatif. Prend par défaut aujourd’hui + 30 jours si aucune date n’est fournie, ou start_date + 30 days si seule start_date est fournie. Doit être égale ou postérieure à start_date et dans les 90 jours suivant aujourd’hui.
string
Fuseau horaire IANA (par ex. Europe/Berlin) utilisé pour interpréter start_date / end_date et regrouper les créneaux par date calendaire. Facultatif — utilise par défaut le fuseau horaire du lieu. Les heures de début des créneaux sont toujours renvoyées en instants UTC (Z) et ne varient jamais selon ce paramètre — la grille des créneaux est toujours projetée depuis le fuseau horaire du lieu ; le paramètre influe uniquement sur le jour calendaire auquel un créneau est rattaché. Les entrées journalières de la réponse couvrent exactement start_date..end_date comme jours calendaires dans ce fuseau horaire. Omets-le sauf si tu affiches le sélecteur dans un autre fuseau horaire.

Réponse

En cas de succès, l’API renvoie 200 OK avec un seul objet de disponibilité.
string
requis
Identifiant du lieu repris tel quel.
string
requis
Fuseau horaire IANA utilisé pour la réponse (par ex., Europe/Berlin) — reprend le paramètre de requête timezone lorsqu’il est fourni, sinon le fuseau horaire du lieu.
integer
Intervalle en minutes entre deux débuts de créneaux réservables consécutifs. Le pas de la grille configurée pour le lieu — chaque créneau de availability tombe sur cette grille. null uniquement lorsque le lieu n’a aucune configuration de planning. Ce n’est pas une durée de rendez-vous : les réservations qui se chevauchent à des heures de début différentes n’entrent pas en conflit ; seules les collisions sur la même heure de début comptent pour la concurrence.
array
requis
Créneaux réservables par jour. Les jours sans aucun créneau réservable sont omis pour garder une réponse légère. Chaque entrée contient :

Réponses d’erreur