Skip to content

Organisation · API reference

The organisation, its settings, members, domain and context key.

Read the context key's date

GET/organization/context-key

Scope : organisation:lire Read the organisation, its settings and members

Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/organization/context-key' \
  -H "x-api-key: $RDV_TOKEN"

Responses

  • 200 Success
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After

Generate a new context key

POST/organization/context-key

Scope : organisation:administrer Change the organisation, its settings, members and routing forms

Creation: the Idempotency-Key header prevents duplicates for 24 hours.

Parameters

NameInTypeRequiredDescription
Idempotency-KeyheaderstringnoUne 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.

Request body

Request example
curl -X POST 'https://www.artibox-calendar.com/api/v1/organization/context-key' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

  • 201 Created
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 409 Conflict: slot taken or request in progress
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After

Read the custom domain

GET/organization/domain

Scope : organisation:lire Read the organisation, its settings and members

Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/organization/domain' \
  -H "x-api-key: $RDV_TOKEN"

Responses

  • 200 Success
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After

Declare a custom domain

POST/organization/domain

Scope : organisation:administrer Change the organisation, its settings, members and routing forms

Creation: the Idempotency-Key header prevents duplicates for 24 hours.

Parameters

NameInTypeRequiredDescription
Idempotency-KeyheaderstringnoUne 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.

Request body

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

Request example
curl -X POST 'https://www.artibox-calendar.com/api/v1/organization/domain' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

  • 201 Created
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 409 Conflict: slot taken or request in progress
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After

Remove the custom domain

DELETE/organization/domain

Scope : organisation:administrer Change the organisation, its settings, members and routing forms

Request example
curl -X DELETE 'https://www.artibox-calendar.com/api/v1/organization/domain' \
  -H "x-api-key: $RDV_TOKEN"

Responses

  • 204 Done, no content
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 429 Too many calls: wait for Retry-After

Verify the custom domain

POST/organization/domain/verify

Scope : organisation:administrer Change the organisation, its settings, members and routing forms

Creation: the Idempotency-Key header prevents duplicates for 24 hours.

Parameters

NameInTypeRequiredDescription
Idempotency-KeyheaderstringnoUne 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.

Request body

Request example
curl -X POST 'https://www.artibox-calendar.com/api/v1/organization/domain/verify' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

  • 200 Success
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 409 Conflict: slot taken or request in progress
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After

List members

GET/members

Scope : organisation:lire Read the organisation, its settings and members

Whole list by default; with page or limit, paginated (25 by default, 500 at most).

Parameters

NameInTypeRequiredDescription
pagequeryintegerno
limitqueryintegerno
pagequeryintegernoNuméro de page, à partir de 1
limitqueryintegernoÉléments par page (500 au plus)
Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/members' \
  -H "x-api-key: $RDV_TOKEN"

Responses

  • 200 Success
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After

Read a member

GET/members/{id}

Scope : organisation:lire Read the organisation, its settings and members

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yesIdentifiant de l'adhésion (membre)
Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/members/{id}' \
  -H "x-api-key: $RDV_TOKEN"

Responses

  • 200 Success
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After

Update a member (role, active)

PUT/members/{id}

Scope : organisation:administrer Change the organisation, its settings, members and routing forms

Parameters

NameInTypeRequiredDescription
idpathstringyes

Request body

Request example
curl -X PUT 'https://www.artibox-calendar.com/api/v1/members/{id}' \
  -H "x-api-key: $RDV_TOKEN"

Responses

  • 200 Success
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After

List invitations

GET/invitations

Scope : organisation:lire Read the organisation, its settings and members

Whole list by default; with page or limit, paginated (25 by default, 500 at most).

Parameters

NameInTypeRequiredDescription
pagequeryintegerno
limitqueryintegerno
pagequeryintegernoNuméro de page, à partir de 1
limitqueryintegernoÉléments par page (500 au plus)
Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/invitations' \
  -H "x-api-key: $RDV_TOKEN"

Responses

  • 200 Success
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After

Invite someone to the organisation

POST/invitations

Scope : organisation:administrer Change the organisation, its settings, members and routing forms

Creation: the Idempotency-Key header prevents duplicates for 24 hours.

Parameters

NameInTypeRequiredDescription
Idempotency-KeyheaderstringnoUne 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.

Request body

Request example
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"}'

Responses

  • 201 Created
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 409 Conflict: slot taken or request in progress
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After

Cancel an invitation

DELETE/invitations/{id}

Scope : organisation:administrer Change the organisation, its settings, members and routing forms

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yes
Request example
curl -X DELETE 'https://www.artibox-calendar.com/api/v1/invitations/{id}' \
  -H "x-api-key: $RDV_TOKEN"

Responses

  • 204 Done, no content
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 429 Too many calls: wait for Retry-After

Read the organisation

GET/organization

Scope : organisation:lire Read the organisation, its settings and members

Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/organization' \
  -H "x-api-key: $RDV_TOKEN"

Responses

  • 200 Success
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After

Update the organisation

PUT/organization

Scope : organisation:administrer Change the organisation, its settings, members and routing forms

Request body

Request example
curl -X PUT 'https://www.artibox-calendar.com/api/v1/organization' \
  -H "x-api-key: $RDV_TOKEN"

Responses

  • 200 Success
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After

Read delays and limits

GET/settings

Scope : organisation:lire Read the organisation, its settings and members

Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/settings' \
  -H "x-api-key: $RDV_TOKEN"

Responses

  • 200 Success
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After

Update delays and limits

PUT/settings

Scope : organisation:administrer Change the organisation, its settings, members and routing forms

Request body

Request example
curl -X PUT 'https://www.artibox-calendar.com/api/v1/settings' \
  -H "x-api-key: $RDV_TOKEN"

Responses

  • 200 Success
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After

Read the settings history

GET/settings/history

Scope : organisation:lire Read the organisation, its settings and members

Paginated list: page and limit (25 by default, 500 at most).

Parameters

NameInTypeRequiredDescription
pagequeryintegernoNuméro de page, à partir de 1
limitqueryintegernoÉléments par page (500 au plus)
Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/settings/history' \
  -H "x-api-key: $RDV_TOKEN"

Responses

  • 200 Success
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After

Read the audit log

GET/audit

Scope : journal:lire Read the organisation's audit log

Paginated list: page and limit (25 by default, 500 at most).

Parameters

NameInTypeRequiredDescription
pagequeryintegerno
limitqueryintegerno
pagequeryintegernoNuméro de page, à partir de 1
limitqueryintegernoÉléments par page (500 au plus)
Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/audit' \
  -H "x-api-key: $RDV_TOKEN"

Responses

  • 200 Success
  • 401 Missing, unknown or expired token
  • 403 Missing scope or right refused
  • 404 Not found (or another organisation's)
  • 422 Data refused: details are given field by field
  • 429 Too many calls: wait for Retry-After