API Reference

Browse REST endpoints by resource.

Generated from the OpenAPI specification.

Account users

Account users represent a user's relationship with an account.

Accounts

An account represents an organization and serves as the core tenancy boundary for all resources in the system.

Appointments

An appointment represents a booking that a client has made with a provider for a specific service.

Blocks

A block represents a range of unavailable time for a provider, service, service provider, or location.

Booking intents

A booking intent tracks the lifecycle of a multi-step booking attempt.

Booking links

A booking link represents a reusable, shareable configuration for booking a service.

Cancellation reasons

A cancellation reason represents an option to choose from when cancelling an appointment.

Client fields

A client field represents a custom data field attached to clients.

Clients

A client represents a person who receives services from providers.

Connected accounts

A connected account represents an external integration, such as Google Calendar or Zoom.

Dashboard sessions

A dashboard session allows you to create seamless, secure login experiences from external systems or integrations.

Forms

A form represents an intake form with typed fields that can be attached to services.

Openings

An opening represents a one-off range of available time for a provider, sitting alongside their recurring schedules.

Platforms

A platform represents an application that manages multiple accounts.

Provider schedules

A provider schedule represents working hours for a provider.

Providers

A provider represents a person who provides services to clients.

Public booking

Endpoints for public booking interfaces.

Roles

A role represents a set of permissions for users in an account.

Schedule groups

A schedule group is a named schedule lineage at the account level (for example, Orientations).

Services

A service represents a specific offering provided by one or more providers.

Time slots

A time slot represents an available range of time for a service.

Schemas

Request and response payload types.