Aller au contenu

Galaxie Artibox

Sondages de dates · Référence de l'API

Proposer des dates, suivre les votes, confirmer une date.

Lister les sondages

GET/polls

Portée : reservations:lire Lire les rendez-vous et les sondages

Les siens, ou tous avec `bookings.all`. Sans `page` ni `limit`, les 100 plus récents en liste simple ; avec, tous, paginés `{items, pagination}`. Jeton : portée `reservations:lire`.

Liste entière par défaut ; avec page ou limit, paginée (25 par défaut, 500 au plus).

Paramètres

NomOùTypeObligatoireDescription
pagerequêteintegernon
limitrequêteintegernon
pagerequêteintegernonNuméro de page, à partir de 1
limitrequêteintegernonÉléments par page (500 au plus)
Exemple de requête
curl -X GET 'https://www.artibox-calendar.com/api/v1/polls' \
  -H "x-api-key: $RDV_TOKEN"

Réponses

  • 200 Réussi
  • 401 Jeton absent, inconnu ou expiré
  • 403 Portée manquante ou droit refusé
  • 404 Introuvable (ou d'une autre organisation)
  • 422 Données refusées : le détail est donné champ par champ
  • 429 Trop d'appels : attendez Retry-After

Créer un sondage de dates

POST/polls

Portée : reservations:ecrire Créer, déplacer, annuler et constater les rendez-vous ; gérer les sondages

Création : l'en-tête Idempotency-Key évite un doublon pendant 24 heures.

Paramètres

NomOùTypeObligatoireDescription
Idempotency-Keyen-têtestringnonUne clé de votre choix (255 caractères au plus) : rejouée dans les 24 heures, la même requête rend la première réponse sans rien recréer ; en cours, 409 ; sur une autre route, 422.

Corps de la requête

`{type_id, title?, guest_name, guest_email, guest_phone?, slots: [ISO 8601]}` — l'adresse n'est donnée qu'ici

Exemple de requête
curl -X POST 'https://www.artibox-calendar.com/api/v1/polls' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{"type_id":"0192f0c4-6a51-7c3e-9d0e-5b1f3a2c4d10","title":"Point d'\''étape","guest_name":"Camille Martin","guest_email":"camille.martin@example.com","slots":["2026-12-01T10:00:00+01:00","2026-12-02T15:00:00+01:00"]}'

Réponses

  • 201 Créé
  • 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

Lire un sondage et ses votes

GET/polls/{id}

Portée : reservations:lire Lire les rendez-vous et les sondages

Paramètres

NomOùTypeObligatoireDescription
idcheminstringoui
Exemple de requête
curl -X GET 'https://www.artibox-calendar.com/api/v1/polls/{id}' \
  -H "x-api-key: $RDV_TOKEN"

Réponses

  • 200 Réussi
  • 401 Jeton absent, inconnu ou expiré
  • 403 Portée manquante ou droit refusé
  • 404 Introuvable (ou d'une autre organisation)
  • 422 Données refusées : le détail est donné champ par champ
  • 429 Trop d'appels : attendez Retry-After

Confirmer une date du sondage (crée le rendez-vous)

POST/polls/{id}/confirm

Portée : reservations:ecrire Créer, déplacer, annuler et constater les rendez-vous ; gérer les sondages

Création : l'en-tête Idempotency-Key évite un doublon pendant 24 heures.

Paramètres

NomOùTypeObligatoireDescription
idcheminstringoui
Idempotency-Keyen-têtestringnonUne clé de votre choix (255 caractères au plus) : rejouée dans les 24 heures, la même requête rend la première réponse sans rien recréer ; en cours, 409 ; sur une autre route, 422.

Corps de la requête

`{start}` — un des créneaux du sondage ; 409 s'il n'est plus libre

Exemple de requête
curl -X POST 'https://www.artibox-calendar.com/api/v1/polls/{id}/confirm' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{"start":"2026-12-01T10:00:00+01:00"}'

Réponses

  • 200 Réussi
  • 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

Clore un sondage

POST/polls/{id}/close

Portée : reservations:ecrire Créer, déplacer, annuler et constater les rendez-vous ; gérer les sondages

Création : l'en-tête Idempotency-Key évite un doublon pendant 24 heures.

Paramètres

NomOùTypeObligatoireDescription
idcheminstringoui
Idempotency-Keyen-têtestringnonUne clé de votre choix (255 caractères au plus) : rejouée dans les 24 heures, la même requête rend la première réponse sans rien recréer ; en cours, 409 ; sur une autre route, 422.

Corps de la requête

Exemple de requête
curl -X POST 'https://www.artibox-calendar.com/api/v1/polls/{id}/close' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

Réponses

  • 200 Réussi
  • 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