Skip to content

Bookings · API reference

Create, read, reschedule, cancel and mark bookings.

List bookings

GET/bookings

Scope : reservations:lire Read bookings and polls

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

Parameters

NameInTypeRequiredDescription
fromquerystring (date-time)no
toquerystring (date-time)no
typequerystring (uuid)no
statusquerystring : confirmed, cancelled, honored, no_showno
labelquerystringno10.3 : l'étiquette du type
organizerquerystring (uuid)no10.3 : un organisateur (superviseur)
context_sourcequerystringno11.9 : la source du contexte signé
context_idquerystringno11.9 : l'identifiant du contexte signé
emailquerystring (email)noLe courriel de l'invité
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/bookings' \
  -H "x-api-key: $RDV_TOKEN"
Response example
{
  "message": "success",
  "data": {
    "items": [
      {
        "id": "0192f0d1-1b2c-7d3e-8f40-a1b2c3d4e5f6",
        "type_id": "0192f0c4-6a51-7c3e-9d0e-5b1f3a2c4d10",
        "label": "Premier échange",
        "organizer": {
          "id": "0192f0c4-0000-7000-8000-000000000001",
          "full_name": "Léa Bernard"
        },
        "start": "2026-12-01T10:00:00+01:00",
        "end": "2026-12-01T10:30:00+01:00",
        "status": "confirmed",
        "mode": "video",
        "guest_name": "Camille Martin",
        "guest_email": "camille.martin@example.com",
        "origin": "api"
      }
    ],
    "pagination": {
      "current_page": 1,
      "total_pages": 4,
      "total_items": 87,
      "items_per_page": 25
    }
  },
  "errors": null
}

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

Book a slot

POST/bookings

Scope : reservations:ecrire Create, reschedule, cancel and mark bookings; manage polls

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/bookings' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{"type_id":"0192f0c4-6a51-7c3e-9d0e-5b1f3a2c4d10","start":"2026-12-01T10:00:00+01:00","name":"Camille Martin","email":"camille.martin@example.com","phone":"+33612345678","timezone":"Europe/Paris","locale":"fr","answers":{"a1":"Présentation de notre projet"}}'
Response example
{
  "message": "success",
  "data": {
    "id": "0192f0d1-1b2c-7d3e-8f40-a1b2c3d4e5f6",
    "type_id": "0192f0c4-6a51-7c3e-9d0e-5b1f3a2c4d10",
    "label": "Premier échange",
    "organizer": {
      "id": "0192f0c4-0000-7000-8000-000000000001",
      "full_name": "Léa Bernard"
    },
    "start": "2026-12-01T10:00:00+01:00",
    "end": "2026-12-01T10:30:00+01:00",
    "status": "confirmed",
    "mode": "video",
    "guest_name": "Camille Martin",
    "guest_email": "camille.martin@example.com",
    "origin": "api",
    "management_token": "…"
  },
  "errors": null
}

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 a booking

GET/bookings/{id}

Scope : reservations:lire Read bookings and polls

Parameters

NameInTypeRequiredDescription
idpathstringyes
Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/bookings/{id}' \
  -H "x-api-key: $RDV_TOKEN"
Response example
{
  "message": "success",
  "data": {
    "id": "0192f0d1-1b2c-7d3e-8f40-a1b2c3d4e5f6",
    "type_id": "0192f0c4-6a51-7c3e-9d0e-5b1f3a2c4d10",
    "label": "Premier échange",
    "organizer": {
      "id": "0192f0c4-0000-7000-8000-000000000001",
      "full_name": "Léa Bernard"
    },
    "start": "2026-12-01T10:00:00+01:00",
    "end": "2026-12-01T10:30:00+01:00",
    "status": "confirmed",
    "mode": "video",
    "guest_name": "Camille Martin",
    "guest_email": "camille.martin@example.com",
    "origin": "api"
  },
  "errors": null
}

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 messages sent or planned for a booking

GET/bookings/{id}/sends

Scope : reservations:lire Read bookings and polls

Parameters

NameInTypeRequiredDescription
idpathstringyes
Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/bookings/{id}/sends' \
  -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 group booking's session and its registrants

GET/bookings/{id}/session

Scope : reservations:lire Read bookings and polls

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yes
Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/bookings/{id}/session' \
  -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

Cancel a booking

POST/bookings/{id}/cancel

Scope : reservations:ecrire Create, reschedule, cancel and mark bookings; manage polls

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

Parameters

NameInTypeRequiredDescription
idpathstringyes
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

`{reason?, channels?: [email|sms]}` — 8.1 : sans `channels`, tous les messages d'annulation actifs

Request example
curl -X POST 'https://www.artibox-calendar.com/api/v1/bookings/{id}/cancel' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{"reason":"Empêchement de dernière minute","channels":["email"]}'
Response example
{
  "message": "success",
  "data": {
    "id": "0192f0d1-1b2c-7d3e-8f40-a1b2c3d4e5f6",
    "type_id": "0192f0c4-6a51-7c3e-9d0e-5b1f3a2c4d10",
    "label": "Premier échange",
    "organizer": {
      "id": "0192f0c4-0000-7000-8000-000000000001",
      "full_name": "Léa Bernard"
    },
    "start": "2026-12-01T10:00:00+01:00",
    "end": "2026-12-01T10:30:00+01:00",
    "status": "confirmed",
    "mode": "video",
    "guest_name": "Camille Martin",
    "guest_email": "camille.martin@example.com",
    "origin": "api"
  },
  "errors": null
}

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

Reschedule a booking

POST/bookings/{id}/move

Scope : reservations:ecrire Create, reschedule, cancel and mark bookings; manage polls

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

Parameters

NameInTypeRequiredDescription
idpathstringyes
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

`{start}` en ISO 8601 avec décalage

Request example
curl -X POST 'https://www.artibox-calendar.com/api/v1/bookings/{id}/move' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{"start":"2026-12-02T14:30:00+01:00"}'
Response example
{
  "message": "success",
  "data": {
    "id": "0192f0d1-1b2c-7d3e-8f40-a1b2c3d4e5f6",
    "type_id": "0192f0c4-6a51-7c3e-9d0e-5b1f3a2c4d10",
    "label": "Premier échange",
    "organizer": {
      "id": "0192f0c4-0000-7000-8000-000000000001",
      "full_name": "Léa Bernard"
    },
    "start": "2026-12-01T10:00:00+01:00",
    "end": "2026-12-01T10:30:00+01:00",
    "status": "confirmed",
    "mode": "video",
    "guest_name": "Camille Martin",
    "guest_email": "camille.martin@example.com",
    "origin": "api"
  },
  "errors": null
}

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

Mark a booking (honoured, no-show)

POST/bookings/{id}/observe

Scope : reservations:ecrire Create, reschedule, cancel and mark bookings; manage polls

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

Parameters

NameInTypeRequiredDescription
idpathstringyes
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

`{status: honored|no_show|confirmed}`

Request example
curl -X POST 'https://www.artibox-calendar.com/api/v1/bookings/{id}/observe' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{"status":"honored"}'
Response example
{
  "message": "success",
  "data": {
    "id": "0192f0d1-1b2c-7d3e-8f40-a1b2c3d4e5f6",
    "type_id": "0192f0c4-6a51-7c3e-9d0e-5b1f3a2c4d10",
    "label": "Premier échange",
    "organizer": {
      "id": "0192f0c4-0000-7000-8000-000000000001",
      "full_name": "Léa Bernard"
    },
    "start": "2026-12-01T10:00:00+01:00",
    "end": "2026-12-01T10:30:00+01:00",
    "status": "confirmed",
    "mode": "video",
    "guest_name": "Camille Martin",
    "guest_email": "camille.martin@example.com",
    "origin": "api"
  },
  "errors": null
}

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

Read a booking's CRM syncs

GET/bookings/{id}/crm

Scope : reservations:lire Read bookings and polls

Parameters

NameInTypeRequiredDescription
idpathstringyes
Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/bookings/{id}/crm' \
  -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