Aller au contenu

Galaxie Artibox

Disponibilités · Référence de l'API

Les plannings, les exceptions et l'aperçu des heures libres des membres.

Lister les plannings

GET/schedules

Portée : disponibilites:lire Lire les plannings, les exceptions, les heures occupées et l'aperçu des disponibilités

Les siens, ou ceux d'un collègue avec `availability.read_others` (superviseur, propriétaire). Jeton : portée `disponibilites:lire`.

Paramètres

NomOùTypeObligatoireDescription
memberrequêtestring (uuid)nonUn collègue (lecture seule)
Exemple de requête
curl -X GET 'https://www.artibox-calendar.com/api/v1/schedules' \
  -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 planning (vide ou copié)

POST/schedules

Portée : disponibilites:ecrire Créer, modifier et supprimer les plannings et les exceptions

Pour le membre appelant (10 au plus). Jeton : portée `disponibilites:ecrire`.

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/schedules' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

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

Renommer un planning

PUT/schedules/{id}

Portée : disponibilites:ecrire Créer, modifier et supprimer les plannings et les exceptions

Toujours ses propres heures (EX-SEC-03) : un planning d'un collègue répond 403, celui d'une autre organisation 404. Jeton : portée `disponibilites:ecrire`.

Paramètres

NomOùTypeObligatoireDescription
idcheminstringoui

Corps de la requête

Exemple de requête
curl -X PUT 'https://www.artibox-calendar.com/api/v1/schedules/{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

Supprimer un planning

DELETE/schedules/{id}

Portée : disponibilites:ecrire Créer, modifier et supprimer les plannings et les exceptions

Toujours ses propres heures (EX-SEC-03) : un planning d'un collègue répond 403, celui d'une autre organisation 404. Le planning par défaut ne se supprime pas. Jeton : portée `disponibilites:ecrire`.

Paramètres

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

Réponses

  • 204 Fait, sans contenu
  • 401 Jeton absent, inconnu ou expiré
  • 403 Portée manquante ou droit refusé
  • 404 Introuvable (ou d'une autre organisation)
  • 429 Trop d'appels : attendez Retry-After

Faire d'un planning celui par défaut

PUT/schedules/{id}/default

Portée : disponibilites:ecrire Créer, modifier et supprimer les plannings et les exceptions

Toujours ses propres heures (EX-SEC-03) : un planning d'un collègue répond 403, celui d'une autre organisation 404. Jeton : portée `disponibilites:ecrire`.

Paramètres

NomOùTypeObligatoireDescription
idcheminstringoui

Corps de la requête

Exemple de requête
curl -X PUT 'https://www.artibox-calendar.com/api/v1/schedules/{id}/default' \
  -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

Régler la semaine type d'un planning

PUT/schedules/{id}/weekly-hours

Portée : disponibilites:ecrire Créer, modifier et supprimer les plannings et les exceptions

Toujours ses propres heures (EX-SEC-03) : un planning d'un collègue répond 403, celui d'une autre organisation 404. Jeton : portée `disponibilites:ecrire`.

Paramètres

NomOùTypeObligatoireDescription
idcheminstringoui

Corps de la requête

`{ranges: [{day: 1-7, start: "HH:MM", end: "HH:MM"}]}` : la semaine entière, qui remplace la précédente

Exemple de requête
curl -X PUT 'https://www.artibox-calendar.com/api/v1/schedules/{id}/weekly-hours' \
  -H "x-api-key: $RDV_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"ranges":[{"day":1,"start":"09:00","end":"12:30"},{"day":1,"start":"14:00","end":"18: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)
  • 422 Données refusées : le détail est donné champ par champ
  • 429 Trop d'appels : attendez Retry-After

Lister les exceptions (congés, heures en plus)

GET/exceptions

Portée : disponibilites:lire Lire les plannings, les exceptions, les heures occupées et l'aperçu des disponibilités

Absences et ouvertures ponctuelles. Jeton : portée `disponibilites:lire`.

Paramètres

NomOùTypeObligatoireDescription
memberrequêtestring (uuid)nonUn collègue (lecture seule, `availability.read_others`)
fromrequêtestring (date)nonDate locale AAAA-MM-JJ
torequêtestring (date)nonDate locale AAAA-MM-JJ
Exemple de requête
curl -X GET 'https://www.artibox-calendar.com/api/v1/exceptions' \
  -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

Ajouter une exception (absence ou heures en plus)

POST/exceptions

Portée : disponibilites:ecrire Créer, modifier et supprimer les plannings et les exceptions

Pour le membre appelant : une absence (journée ou heures) ou une ouverture ponctuelle (`available: true`, heures exigées). Jeton : portée `disponibilites:ecrire`.

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/exceptions' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{"date":"2026-12-24","available":false,"reason":"Congés"}'

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

Modifier une exception

PUT/exceptions/{id}

Portée : disponibilites:ecrire Créer, modifier et supprimer les plannings et les exceptions

Les champs absents gardent leur valeur. Toujours ses propres heures (EX-SEC-03) : une exception d'un collègue répond 403, celle d'une autre organisation 404. Jeton : portée `disponibilites:ecrire`.

Paramètres

NomOùTypeObligatoireDescription
idcheminstringoui

Corps de la requête

Exemple de requête
curl -X PUT 'https://www.artibox-calendar.com/api/v1/exceptions/{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

Supprimer une exception

DELETE/exceptions/{id}

Portée : disponibilites:ecrire Créer, modifier et supprimer les plannings et les exceptions

Toujours ses propres heures (EX-SEC-03) : une exception d'un collègue répond 403, celle d'une autre organisation 404. Jeton : portée `disponibilites:ecrire`.

Paramètres

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

Réponses

  • 204 Fait, sans contenu
  • 401 Jeton absent, inconnu ou expiré
  • 403 Portée manquante ou droit refusé
  • 404 Introuvable (ou d'une autre organisation)
  • 429 Trop d'appels : attendez Retry-After

Aperçu des disponibilités d'un membre

GET/availability/preview

Portée : disponibilites:lire Lire les plannings, les exceptions, les heures occupées et l'aperçu des disponibilités

Paramètres

NomOùTypeObligatoireDescription
fromrequêtestring (date-time)nonISO 8601 avec décalage
torequêtestring (date-time)nonISO 8601 avec décalage, 62 jours au plus après from
durationrequêteintegernon
schedulerequêtestring (uuid)non
Exemple de requête
curl -X GET 'https://www.artibox-calendar.com/api/v1/availability/preview' \
  -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 les heures occupées d'un membre (31 jours au plus)

GET/busy-times

Portée : disponibilites:lire Lire les plannings, les exceptions, les heures occupées et l'aperçu des disponibilités

Intervalles occupés, fusionnés par source : `booking` (rendez-vous de l'application, marges comprises) ou `calendar` (agendas connectés qui vérifient les conflits). Jamais le titre d'un événement. Un collègue avec `availability.read_others` seulement. Jeton : portée `disponibilites:lire`.

Paramètres

NomOùTypeObligatoireDescription
memberrequêtestringnon`me` (par défaut) ou l'identifiant d'un membre
fromrequêtestring (date-time)ouiISO 8601 avec décalage
torequêtestring (date-time)ouiISO 8601 avec décalage, 31 jours au plus après from (2 h de tolérance pour un changement d'heure)
Exemple de requête
curl -X GET 'https://www.artibox-calendar.com/api/v1/busy-times' \
  -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