Skip to content

Availability · API reference

Members' schedules, exceptions and availability preview.

List schedules

GET/schedules

Scope : disponibilites:lire Read schedules, exceptions, busy times and the availability preview

Parameters

NameInTypeRequiredDescription
memberquerystring (uuid)noUn collègue (lecture seule)
Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/schedules' \
  -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

Create a schedule (empty or copied)

POST/schedules

Scope : disponibilites:ecrire Create, change and delete schedules and exceptions

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

Rename a schedule

PUT/schedules/{id}

Scope : disponibilites:ecrire Create, change and delete schedules and exceptions

Parameters

NameInTypeRequiredDescription
idpathstringyes

Request body

Request example
curl -X PUT 'https://www.artibox-calendar.com/api/v1/schedules/{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

Delete a schedule

DELETE/schedules/{id}

Scope : disponibilites:ecrire Create, change and delete schedules and exceptions

Parameters

NameInTypeRequiredDescription
idpathstringyes
Request example
curl -X DELETE 'https://www.artibox-calendar.com/api/v1/schedules/{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

Make a schedule the default one

PUT/schedules/{id}/default

Scope : disponibilites:ecrire Create, change and delete schedules and exceptions

Parameters

NameInTypeRequiredDescription
idpathstringyes

Request body

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

Set a schedule's weekly hours

PUT/schedules/{id}/weekly-hours

Scope : disponibilites:ecrire Create, change and delete schedules and exceptions

Parameters

NameInTypeRequiredDescription
idpathstringyes

Request body

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

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

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 exceptions (time off, extra hours)

GET/exceptions

Scope : disponibilites:lire Read schedules, exceptions, busy times and the availability preview

Parameters

NameInTypeRequiredDescription
memberquerystring (uuid)noUn collègue (lecture seule, `availability.read_others`)
fromquerystring (date)noDate locale AAAA-MM-JJ
toquerystring (date)noDate locale AAAA-MM-JJ
Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/exceptions' \
  -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

Add an exception (time off or extra hours)

POST/exceptions

Scope : disponibilites:ecrire Create, change and delete schedules and exceptions

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/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"}'

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

Update an exception

PUT/exceptions/{id}

Scope : disponibilites:ecrire Create, change and delete schedules and exceptions

Parameters

NameInTypeRequiredDescription
idpathstringyes

Request body

Request example
curl -X PUT 'https://www.artibox-calendar.com/api/v1/exceptions/{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

Delete an exception

DELETE/exceptions/{id}

Scope : disponibilites:ecrire Create, change and delete schedules and exceptions

Parameters

NameInTypeRequiredDescription
idpathstringyes
Request example
curl -X DELETE 'https://www.artibox-calendar.com/api/v1/exceptions/{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

Preview a member's availability

GET/availability/preview

Scope : disponibilites:lire Read schedules, exceptions, busy times and the availability preview

Parameters

NameInTypeRequiredDescription
fromquerystring (date-time)noISO 8601 avec décalage
toquerystring (date-time)noISO 8601 avec décalage, 62 jours au plus après from
durationqueryintegerno
schedulequerystring (uuid)no
Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/availability/preview' \
  -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's busy times (31 days at most)

GET/busy-times

Scope : disponibilites:lire Read schedules, exceptions, busy times and the availability preview

Parameters

NameInTypeRequiredDescription
memberquerystringno`me` (par défaut) ou l'identifiant d'un membre
fromquerystring (date-time)yesISO 8601 avec décalage
toquerystring (date-time)yesISO 8601 avec décalage, 31 jours au plus après from (2 h de tolérance pour un changement d'heure)
Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/busy-times' \
  -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