Skip to content

API reference

Every route of the Artibox Calendar public API: scopes, parameters, request and response examples, errors.

Base URL
https://www.artibox-calendar.com/api/v1

Authentication

Send a personal token (rdv_pat_…) or an OAuth access token (rdv_oat_…) in the x-api-key header. Each route needs a scope.

curl 'https://www.artibox-calendar.com/api/v1/me/context' \
  -H "x-api-key: $RDV_TOKEN"
Read the quick start guide

Scopes

ScopeDescription
utilisateur:lireRead the token's account, context and notifications
organisation:lireRead the organisation, its settings and members
organisation:administrerChange the organisation, its settings, members and routing forms
types:lireRead event types, their slots and messages
types:ecrireCreate, change and delete event types
disponibilites:lireRead schedules, exceptions, busy times and the availability preview
disponibilites:ecrireCreate, change and delete schedules and exceptions
reservations:lireRead bookings and polls
reservations:ecrireCreate, reschedule, cancel and mark bookings; manage polls
liens:ecrireCreate single-use links, signed links and link sends
webhooks:ecrireManage webhook subscriptions and replay deliveries
journal:lireRead the organisation's audit log
donnees:effacerExport and erase a guest's personal data (GDPR)

Limits

100 calls per minute per token. Each response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset; beyond that, 429 and Retry-After.

Errors

HTTPDescription
401Missing, unknown or expired token
403Missing scope or right refused
404Not found (or another organisation's)
409Conflict: slot taken or request in progress
422Data refused: details are given field by field
429Too many calls: wait for Retry-After
{
  "message": "error",
  "data": null,
  "errors": {
    "error": "…",
    "validation": {
      "start": [
        "…"
      ]
    }
  }
}

Account and context

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

4 routes

Event types

The organisation's event types, their settings and their slots.

9 routes

Availability

Members' schedules, exceptions and availability preview.

12 routes

Bookings

Create, read, reschedule, cancel and mark bookings.

9 routes

One-off meetings

Meetings on hand-picked slots, offered once to a guest.

4 routes

Single-use and signed links

Single-use booking links and signed links carrying a context (11.8).

4 routes

Link sends

Send an event type's link by email or SMS, and remind.

3 routes

Type messages

The messages sent to an event type's guests (confirmation, reminder…).

3 routes

Meeting polls

Offer dates, follow the votes, confirm a date.

5 routes

Organisation

The organisation, its settings, members, domain and context key.

20 routes

Routing forms

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

7 routes

Webhooks

Event subscriptions, their deliveries and their test.

8 routes

Personal data

Export and erase a guest's data (GDPR).

3 routes

OAuth server

Exchange a code, refresh, revoke and introspect an OAuth app's tokens.

3 routes

MCP server

The MCP endpoint for AI assistants and agents.

3 routes