Members' schedules, exceptions and availability preview.
List schedules
GET/schedules
Scope : disponibilites:lireRead schedules, exceptions, busy times and the availability preview
Parameters
Name
In
Type
Required
Description
member
query
string (uuid)
no
Un 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:ecrireCreate, change and delete schedules and exceptions
Creation: the Idempotency-Key header prevents duplicates for 24 hours.
Parameters
Name
In
Type
Required
Description
Idempotency-Key
header
string
no
Une 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.
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:lireRead schedules, exceptions, busy times and the availability preview
Parameters
Name
In
Type
Required
Description
member
query
string (uuid)
no
Un collègue (lecture seule, `availability.read_others`)
from
query
string (date)
no
Date locale AAAA-MM-JJ
to
query
string (date)
no
Date 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:ecrireCreate, change and delete schedules and exceptions
Creation: the Idempotency-Key header prevents duplicates for 24 hours.
Parameters
Name
In
Type
Required
Description
Idempotency-Key
header
string
no
Une 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.