Skip to content

Account and context · API reference

The token's account, organisation, rights and notifications.

Read the token's account (OAuth userinfo)

GET/users/me

Scope : utilisateur:lire Read the token's account, context and notifications

Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/users/me' \
  -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 the account's notifications

GET/notifications

Scope : utilisateur:lire Read the token's account, context and notifications

Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/notifications' \
  -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

Mark one's notifications as read

POST/notifications/read

Scope : utilisateur:lire Read the token's account, context and notifications

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

`{ids?: [uuid]}` — sans liste, toutes

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

Responses

  • 204 Done, no content
  • 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 account, the current organisation and its rights

GET/me/context

Scope : utilisateur:lire Read the token's account, context and notifications

Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/me/context' \
  -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