Aller au contenu

Galaxie Artibox

Organisation · Référence de l'API

L'organisation, ses réglages, ses membres, son domaine et sa clé de contexte.

Lire la date de la clé de contexte

GET/organization/context-key

Portée : organisation:lire Lire l'organisation, ses réglages et ses membres

Exemple de requête
curl -X GET 'https://www.artibox-calendar.com/api/v1/organization/context-key' \
  -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

Générer une nouvelle clé de contexte

POST/organization/context-key

Portée : organisation:administrer Modifier l'organisation, ses réglages, ses membres et ses formulaires d'orientation

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/organization/context-key' \
  -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

Lire le domaine personnalisé

GET/organization/domain

Portée : organisation:lire Lire l'organisation, ses réglages et ses membres

Exemple de requête
curl -X GET 'https://www.artibox-calendar.com/api/v1/organization/domain' \
  -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

Déclarer un domaine personnalisé

POST/organization/domain

Portée : organisation:administrer Modifier l'organisation, ses réglages, ses membres et ses formulaires d'orientation

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

`{domain}` — par exemple rdv.client.fr

Exemple de requête
curl -X POST 'https://www.artibox-calendar.com/api/v1/organization/domain' \
  -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

Retirer le domaine personnalisé

DELETE/organization/domain

Portée : organisation:administrer Modifier l'organisation, ses réglages, ses membres et ses formulaires d'orientation

Exemple de requête
curl -X DELETE 'https://www.artibox-calendar.com/api/v1/organization/domain' \
  -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

Vérifier le domaine personnalisé

POST/organization/domain/verify

Portée : organisation:administrer Modifier l'organisation, ses réglages, ses membres et ses formulaires d'orientation

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/organization/domain/verify' \
  -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

Lister les membres

GET/members

Portée : organisation:lire Lire l'organisation, ses réglages et ses membres

Jeton : portée `organisation:lire`. Sans `page` ni `limit`, une liste simple ; avec, la forme paginée `{items, pagination}`.

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/members' \
  -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 un membre

GET/members/{id}

Portée : organisation:lire Lire l'organisation, ses réglages et ses membres

Jeton : portée `organisation:lire`. Un membre d'une autre organisation répond 404.

Paramètres

NomOùTypeObligatoireDescription
idcheminstring (uuid)ouiIdentifiant de l'adhésion (membre)
Exemple de requête
curl -X GET 'https://www.artibox-calendar.com/api/v1/members/{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

Modifier un membre (rôle, activité)

PUT/members/{id}

Portée : organisation:administrer Modifier l'organisation, ses réglages, ses membres et ses formulaires d'orientation

Paramètres

NomOùTypeObligatoireDescription
idcheminstringoui

Corps de la requête

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

Lister les invitations

GET/invitations

Portée : organisation:lire Lire l'organisation, ses réglages et ses membres

Propriétaire seulement (5.2). Jeton : portée `organisation:lire`. Sans `page` ni `limit`, une liste simple ; avec, `{items, pagination}`.

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/invitations' \
  -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

Inviter une personne dans l'organisation

POST/invitations

Portée : organisation:administrer Modifier l'organisation, ses réglages, ses membres et ses formulaires d'orientation

Propriétaire seulement. Jeton : portée `organisation:administrer`. Une place de la formule est exigée (M1, `members.multiple`) : sinon 403 avec `errors.reason = plan_required`.

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/invitations' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{"email":"camille.martin@example.com","role":"member"}'

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

Annuler une invitation

DELETE/invitations/{id}

Portée : organisation:administrer Modifier l'organisation, ses réglages, ses membres et ses formulaires d'orientation

Propriétaire seulement. Jeton : portée `organisation:administrer`. Le lien envoyé n'ouvre plus rien.

Paramètres

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

Lire l'organisation

GET/organization

Portée : organisation:lire Lire l'organisation, ses réglages et ses membres

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

Modifier l'organisation

PUT/organization

Portée : organisation:administrer Modifier l'organisation, ses réglages, ses membres et ses formulaires d'orientation

Corps de la requête

Exemple de requête
curl -X PUT 'https://www.artibox-calendar.com/api/v1/organization' \
  -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 délais et limites

GET/settings

Portée : organisation:lire Lire l'organisation, ses réglages et ses membres

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

Modifier les délais et limites

PUT/settings

Portée : organisation:administrer Modifier l'organisation, ses réglages, ses membres et ses formulaires d'orientation

Corps de la requête

Exemple de requête
curl -X PUT 'https://www.artibox-calendar.com/api/v1/settings' \
  -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 l'historique des réglages

GET/settings/history

Portée : organisation:lire Lire l'organisation, ses réglages et ses membres

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

Paramètres

NomOùTypeObligatoireDescription
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/settings/history' \
  -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 le journal d'audit

GET/audit

Portée : journal:lire Lire le journal d'audit de l'organisation

Les actions sensibles, de la plus récente à la plus ancienne. Propriétaire seulement. Jeton : portée `journal:lire`.

Liste paginée : page et limit (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/audit' \
  -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