Scheduling API documentation for developers
A REST API, signed webhooks, OAuth 2 with PKCE, an embed widget, Zapier, Make and an MCP server. Everything you need to plug scheduling into your product.
This scheduling API documentation is for developers who want to read availability, book, reschedule or cancel meetings from their own code, get notified in real time, or offer Artibox Calendar to their own customers.
What the scheduling API documentation covers
The public API is the application's own: the /api/v1 routes open to tokens. A token acts on behalf of a member, with their rights and only the scopes it was given. The rules are those of the booking page: notice, buffers, daily maximum, connected calendars, locked booking.
The full description is generated from the code and published as OpenAPI 3.1: download openapi.json to generate a client, or browse the API reference, route by route.
Where to start
Quick start
A token, a first call, your event types, a free slot, a booking. In five minutes.
Authentication
Personal tokens, scopes, OAuth 2 with PKCE step by step, refresh and revocation.
API reference
Every route with its scope, parameters, request and response examples.
Webhooks
Events, payloads and signature verification in Node.js, PHP and Python.
Embed in your platform or CRM
Multi-organisation OAuth app, signed context links, prefill and sync.
Embed widget
A popup, a badge or an inline block on your site, with its events.
Zapier and Make
No-code automation on top of the same webhooks and API.
Limits, errors and pagination
Response envelope, error codes, 100 calls a minute, idempotency, dates.
MCP server
Let an AI assistant find a slot and book it, with your token's rights.
API changelog
What changed in the API, release after release.
API principles
- One address: the API answers under
/api/v1on the application's domain; the exact URL is at the top of the reference. - One header: send the token in
x-api-key, personal (rdv_pat_…) or from OAuth (rdv_oat_…). - Scopes: each route needs a scope, such as
reservations:ecrireto book. Outside it, 403. - One envelope: every response is
{message, data, errors}; input errors come field by field. - Isolation: another organisation's resource answers 404, never 403.
- Unambiguous times: every date is ISO 8601 with its offset (
2026-12-01T10:00:00+01:00).
The API and OAuth apps come with the Pro plan, webhooks with the Team plan: see pricing. The product overview is on the API and webhooks page.
Frequently asked questions
Is there an OpenAPI description?
Yes, OpenAPI 3.1, generated from the real routes: openapi.json. It describes only the routes open to tokens, each with its scope, plus the webhook events.
Do I need an account to read the docs?
No. The documentation and reference are public. To call the API you need a token, created in Settings › Integrations by a member of an organisation on the Pro plan or above.
Can a token see all of the organisation's data?
No. A token has exactly the rights of the member who created or authorised it, limited to its scopes.
Create your first token
Open your free account, switch to Pro and make your first call in minutes.
Create my account