Skip to content

Routing forms · API reference

The forms that route a guest to the right event type or person.

List routing forms

GET/orientation-forms

Scope : types:lire Read event types, their slots and messages

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/orientation-forms' \
  -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 routing form

POST/orientation-forms

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/orientation-forms' \
  -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

List a routing form's submissions

GET/orientation-forms/{id}/submissions

Scope : types:lire Read event types, their slots and messages

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

Parameters

NameInTypeRequiredDescription
idpathstring (uuid)yesLe formulaire
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/orientation-forms/{id}/submissions' \
  -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 routing form submission

GET/orientation-submissions/{id}

Scope : types:lire Read event types, their slots and messages

Parameters

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

Read a routing form

GET/orientation-forms/{id}

Scope : types:lire Read event types, their slots and messages

Parameters

NameInTypeRequiredDescription
idpathstringyes
Request example
curl -X GET 'https://www.artibox-calendar.com/api/v1/orientation-forms/{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 routing form

PUT/orientation-forms/{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/orientation-forms/{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 routing form

DELETE/orientation-forms/{id}

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

Parameters

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