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
- Version 1.0.0
- OpenAPI 3.1 description (JSON)
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"Scopes
| Scope | Description |
|---|---|
utilisateur:lire | Read the token's account, context and notifications |
organisation:lire | Read the organisation, its settings and members |
organisation:administrer | Change the organisation, its settings, members and routing forms |
types:lire | Read event types, their slots and messages |
types:ecrire | Create, change and delete event types |
disponibilites:lire | Read schedules, exceptions, busy times and the availability preview |
disponibilites:ecrire | Create, change and delete schedules and exceptions |
reservations:lire | Read bookings and polls |
reservations:ecrire | Create, reschedule, cancel and mark bookings; manage polls |
liens:ecrire | Create single-use links, signed links and link sends |
webhooks:ecrire | Manage webhook subscriptions and replay deliveries |
journal:lire | Read the organisation's audit log |
donnees:effacer | Export 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
| HTTP | Description |
|---|---|
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 |
{
"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
/typesList event types/typesCreate an event type/types/templatesList the event type templates offered at creation/types/slug-checkCheck that an event type address is free/types/slot-previewPreview the slots of unsaved settings/types/{id}Read an event type/types/{id}Update an event type/types/{id}Delete an event type/types/{id}/slotsFind an event type's available slots
Availability
Members' schedules, exceptions and availability preview.
12 routes
/schedulesList schedules/schedulesCreate a schedule (empty or copied)/schedules/{id}Rename a schedule/schedules/{id}Delete a schedule/schedules/{id}/defaultMake a schedule the default one/schedules/{id}/weekly-hoursSet a schedule's weekly hours/exceptionsList exceptions (time off, extra hours)/exceptionsAdd an exception (time off or extra hours)/exceptions/{id}Update an exception/exceptions/{id}Delete an exception/availability/previewPreview a member's availability/busy-timesRead a member's busy times (31 days at most)
Bookings
Create, read, reschedule, cancel and mark bookings.
9 routes
/bookingsList bookings/bookingsBook a slot/bookings/{id}Read a booking/bookings/{id}/sendsList the messages sent or planned for a booking/bookings/{id}/sessionRead a group booking's session and its registrants/bookings/{id}/cancelCancel a booking/bookings/{id}/moveReschedule a booking/bookings/{id}/observeMark a booking (honoured, no-show)/bookings/{id}/crmRead a booking's CRM syncs
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
/organization/context-keyRead the context key's date/organization/context-keyGenerate a new context key/organization/domainRead the custom domain/organization/domainDeclare a custom domain/organization/domainRemove the custom domain/organization/domain/verifyVerify the custom domain/membersList members/members/{id}Read a member/members/{id}Update a member (role, active)/invitationsList invitations/invitationsInvite someone to the organisation/invitations/{id}Cancel an invitation/organizationRead the organisation/organizationUpdate the organisation/organization/logoRead the organisation's logo/organization/logoUpload the organisation's logo/settingsRead delays and limits/settingsUpdate delays and limits/settings/historyRead the settings history/auditRead the audit log
Routing forms
The forms that route a guest to the right event type or person.
7 routes
/orientation-formsList routing forms/orientation-formsCreate a routing form/orientation-forms/{id}/submissionsList a routing form's submissions/orientation-submissions/{id}Read a routing form submission/orientation-forms/{id}Read a routing form/orientation-forms/{id}Update a routing form/orientation-forms/{id}Delete a routing form
Webhooks
Event subscriptions, their deliveries and their test.
8 routes
/webhook-subscriptionsList webhook subscriptions/webhook-subscriptionsSubscribe to events/webhook-subscriptions/{id}Read a subscription/webhook-subscriptions/{id}Update a subscription/webhook-subscriptions/{id}Delete a subscription/webhook-subscriptions/{id}/deliveriesList a subscription's deliveries (30 days)/webhook-subscriptions/{id}/testSend a test event/webhook-deliveries/{id}/replayReplay a delivery
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