Calendeur
API key

API reference

Calendeur REST API

A JSON API over HTTPS. Requests and responses use snake_case fields and ISO 8601 times in UTC. The full machine-readable description is in the OpenAPI 3.1 spec.

Base URL

Base URL
https://calendeur.com/api/v1

Conventions

  • Every object has an id and an object type such as "booking".
  • Lists return { data, has_more, next_cursor }. Pass cursor=next_cursor for the next page and limit (1 to 100) to change page size.
  • Unknown fields in requests are ignored. New fields may be added to responses; don't fail on fields you don't recognise.
  • The API is versioned in the path. Breaking changes will ship as a new version, never inside v1.

Resources

Account

Check a key and see who it belongs to.

  • GET/me

Event types

The kinds of meetings people can book.

  • GET/event-types
  • GET/event-types/{id}

Availability

Open times you can book.

  • GET/availability

Bookings

Create, read, reschedule and cancel meetings.

  • POST/bookings
  • GET/bookings
  • GET/bookings/{id}
  • POST/bookings/{id}/reschedule
  • POST/bookings/{id}/cancel

Meeting notes

Feed notes from meetings held anywhere.

  • POST/bookings/{id}/notes

Contacts

The CRM: people, their details and history.

  • GET/contacts
  • POST/contacts
  • GET/contacts/{id}
  • PATCH/contacts/{id}

Routing forms

Qualify and route people from your own UI.

  • GET/routing-forms
  • GET/routing-forms/{id}
  • POST/routing-forms/{id}/submissions

Webhooks

Get notified when things change.

  • POST/webhooks
  • GET/webhooks
  • DELETE/webhooks/{id}
PreviousErrors & rate limitsNext Account