API

Connect your own CRM or software to Schedulinq: plan, invite and add team members from your own system, and hear about every change through webhooks.

• OverviewWhat the Schedulinq API is for, the three buttons a CRM gets, and what it deliberately leaves to the dashboard.
• Authentication and API keysCreate an API key under Integrations → API, choose its scopes, send it as a Bearer token — and keep it out of browsers, URLs and repositories.
• QuickstartThe three CRM buttons end to end with curl — plan, invite, create a team member — and your first webhook.
• Planning linksThe Plan button — mint a link when the caller clicks, send them to Schedulinq's planner with the lead already filled in, and come back to your CRM.
• InvitationsThe Invite button — one call sends the customer an invitation to book with one of the team members you chose.
• AppointmentsRead appointments back — one by id, or every one with a metadata value — and follow an appointment that moved to a new id.
• ColleaguesRead your team members, create a buyer per campaign, and know when they are ready to be planned.
• MetadataYour own references — a deal id, a campaign id — on invitations and appointments, copied along and handed back on every webhook.
• WebhooksHear about every change — add an endpoint, verify the signature, answer quickly, and know what happens when your server is down.
• Webhook eventsEvery event, when it is sent, and an example payload of each.
• ErrorsThe shape of every error, what each code means and what to do about it.
• IdempotencyRetry a creating call safely — the same Idempotency-Key replays the first answer instead of creating twice.
• Rate limits300 requests a minute per key, bursts allowed — the headers that tell you where you stand.
• Versioning and changelog/v1 stays compatible — what counts as a breaking change, how we announce it, and every change to the API.
• ReferenceEvery endpoint of the Schedulinq API — parameters, request bodies, responses, errors and the scope each needs — generated from the API description.