Aller au contenu

Galaxie Artibox

Rendez-vous · Référence de l'API

Créer, lire, déplacer, annuler et constater les rendez-vous.

Lister les rendez-vous

GET/bookings

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

Liste paginée : page et limit (25 par défaut, 500 au plus).

Paramètres

NomOùTypeObligatoireDescription
fromrequêtestring (date-time)non
torequêtestring (date-time)non
typerequêtestring (uuid)non
statusrequêtestring : confirmed, cancelled, honored, no_shownon
labelrequêtestringnon10.3 : l'étiquette du type
organizerrequêtestring (uuid)non10.3 : un organisateur (superviseur)
context_sourcerequêtestringnon11.9 : la source du contexte signé
context_idrequêtestringnon11.9 : l'identifiant du contexte signé
emailrequêtestring (email)nonLe courriel de l'invité
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/bookings' \
  -H "x-api-key: $RDV_TOKEN"
Exemple de réponse
{
  "message": "success",
  "data": {
    "items": [
      {
        "id": "0192f0d1-1b2c-7d3e-8f40-a1b2c3d4e5f6",
        "type_id": "0192f0c4-6a51-7c3e-9d0e-5b1f3a2c4d10",
        "label": "Premier échange",
        "organizer": {
          "id": "0192f0c4-0000-7000-8000-000000000001",
          "full_name": "Léa Bernard"
        },
        "start": "2026-12-01T10:00:00+01:00",
        "end": "2026-12-01T10:30:00+01:00",
        "status": "confirmed",
        "mode": "video",
        "guest_name": "Camille Martin",
        "guest_email": "camille.martin@example.com",
        "origin": "api"
      }
    ],
    "pagination": {
      "current_page": 1,
      "total_pages": 4,
      "total_items": 87,
      "items_per_page": 25
    }
  },
  "errors": null
}

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

Réserver un créneau

POST/bookings

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

Exemple de requête
curl -X POST 'https://www.artibox-calendar.com/api/v1/bookings' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{"type_id":"0192f0c4-6a51-7c3e-9d0e-5b1f3a2c4d10","start":"2026-12-01T10:00:00+01:00","name":"Camille Martin","email":"camille.martin@example.com","phone":"+33612345678","timezone":"Europe/Paris","locale":"fr","answers":{"a1":"Présentation de notre projet"}}'
Exemple de réponse
{
  "message": "success",
  "data": {
    "id": "0192f0d1-1b2c-7d3e-8f40-a1b2c3d4e5f6",
    "type_id": "0192f0c4-6a51-7c3e-9d0e-5b1f3a2c4d10",
    "label": "Premier échange",
    "organizer": {
      "id": "0192f0c4-0000-7000-8000-000000000001",
      "full_name": "Léa Bernard"
    },
    "start": "2026-12-01T10:00:00+01:00",
    "end": "2026-12-01T10:30:00+01:00",
    "status": "confirmed",
    "mode": "video",
    "guest_name": "Camille Martin",
    "guest_email": "camille.martin@example.com",
    "origin": "api",
    "management_token": "…"
  },
  "errors": null
}

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 rendez-vous

GET/bookings/{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/bookings/{id}' \
  -H "x-api-key: $RDV_TOKEN"
Exemple de réponse
{
  "message": "success",
  "data": {
    "id": "0192f0d1-1b2c-7d3e-8f40-a1b2c3d4e5f6",
    "type_id": "0192f0c4-6a51-7c3e-9d0e-5b1f3a2c4d10",
    "label": "Premier échange",
    "organizer": {
      "id": "0192f0c4-0000-7000-8000-000000000001",
      "full_name": "Léa Bernard"
    },
    "start": "2026-12-01T10:00:00+01:00",
    "end": "2026-12-01T10:30:00+01:00",
    "status": "confirmed",
    "mode": "video",
    "guest_name": "Camille Martin",
    "guest_email": "camille.martin@example.com",
    "origin": "api"
  },
  "errors": null
}

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

Lister les messages envoyés ou prévus pour un rendez-vous

GET/bookings/{id}/sends

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/bookings/{id}/sends' \
  -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

Lire la séance d'un rendez-vous de groupe et ses inscrits

GET/bookings/{id}/session

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

Les inscrits qui partagent l'organisateur et le début de ce rendez-vous (format « groupe »), annulés compris, avec leur statut. Mêmes droits que la fiche du rendez-vous. Jeton : portée `reservations:lire`.

Paramètres

NomOùTypeObligatoireDescription
idcheminstring (uuid)oui
Exemple de requête
curl -X GET 'https://www.artibox-calendar.com/api/v1/bookings/{id}/session' \
  -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

Annuler un rendez-vous

POST/bookings/{id}/cancel

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

`{reason?, channels?: [email|sms]}` — 8.1 : sans `channels`, tous les messages d'annulation actifs

Exemple de requête
curl -X POST 'https://www.artibox-calendar.com/api/v1/bookings/{id}/cancel' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{"reason":"Empêchement de dernière minute","channels":["email"]}'
Exemple de réponse
{
  "message": "success",
  "data": {
    "id": "0192f0d1-1b2c-7d3e-8f40-a1b2c3d4e5f6",
    "type_id": "0192f0c4-6a51-7c3e-9d0e-5b1f3a2c4d10",
    "label": "Premier échange",
    "organizer": {
      "id": "0192f0c4-0000-7000-8000-000000000001",
      "full_name": "Léa Bernard"
    },
    "start": "2026-12-01T10:00:00+01:00",
    "end": "2026-12-01T10:30:00+01:00",
    "status": "confirmed",
    "mode": "video",
    "guest_name": "Camille Martin",
    "guest_email": "camille.martin@example.com",
    "origin": "api"
  },
  "errors": null
}

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

Déplacer un rendez-vous

POST/bookings/{id}/move

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}` en ISO 8601 avec décalage

Exemple de requête
curl -X POST 'https://www.artibox-calendar.com/api/v1/bookings/{id}/move' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{"start":"2026-12-02T14:30:00+01:00"}'
Exemple de réponse
{
  "message": "success",
  "data": {
    "id": "0192f0d1-1b2c-7d3e-8f40-a1b2c3d4e5f6",
    "type_id": "0192f0c4-6a51-7c3e-9d0e-5b1f3a2c4d10",
    "label": "Premier échange",
    "organizer": {
      "id": "0192f0c4-0000-7000-8000-000000000001",
      "full_name": "Léa Bernard"
    },
    "start": "2026-12-01T10:00:00+01:00",
    "end": "2026-12-01T10:30:00+01:00",
    "status": "confirmed",
    "mode": "video",
    "guest_name": "Camille Martin",
    "guest_email": "camille.martin@example.com",
    "origin": "api"
  },
  "errors": null
}

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

Constater un rendez-vous (honoré, absent)

POST/bookings/{id}/observe

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

`{status: honored|no_show|confirmed}`

Exemple de requête
curl -X POST 'https://www.artibox-calendar.com/api/v1/bookings/{id}/observe' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{"status":"honored"}'
Exemple de réponse
{
  "message": "success",
  "data": {
    "id": "0192f0d1-1b2c-7d3e-8f40-a1b2c3d4e5f6",
    "type_id": "0192f0c4-6a51-7c3e-9d0e-5b1f3a2c4d10",
    "label": "Premier échange",
    "organizer": {
      "id": "0192f0c4-0000-7000-8000-000000000001",
      "full_name": "Léa Bernard"
    },
    "start": "2026-12-01T10:00:00+01:00",
    "end": "2026-12-01T10:30:00+01:00",
    "status": "confirmed",
    "mode": "video",
    "guest_name": "Camille Martin",
    "guest_email": "camille.martin@example.com",
    "origin": "api"
  },
  "errors": null
}

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

Lire les synchronisations CRM d'un rendez-vous

GET/bookings/{id}/crm

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/bookings/{id}/crm' \
  -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