The busy time object

string

The busy time's unique identifier.

Example:

"bti_01HQFQ9QWTNNPY58FZ8CB3FWWK"

location_id

string

The location identifier where the busy time takes place.

Example:

"loc_01HQFQ9QWTNNPY58FZ8CB3FWWK"

practitioner_id

string

The practitioner identifier assigned to the busy time.

Example:

"pra_01HQFQ9QWTNNPY58FZ8CB3FWWK"

starts_at

string

The busy time start time (ISO 8601).

Example:

"2024-01-01T10:00:00Z"

ends_at

string

The busy time end time (ISO 8601).

Example:

"2024-01-01T11:00:00Z"

duration

integer

The busy time duration in minutes.

Example:

60

name

string | null

The busy time name.

Example:

"Lunch break"

note

string | null

The busy time note.

Example:

"Practitioner unavailable for personal appointment."

created_at

string

The timestamp when the busy time was created (ISO 8601).

Example:

"2024-01-01T12:00:00Z"

List all busy times

{
  "id": "<string>",
  "location_id": "<string>",
  "practitioner_id": "<string>",
  "starts_at": "<string>",
  "ends_at": "<string>",
  "duration": 123,
  "name": "Lunch break",
  "note": "Practitioner unavailable for personal appointment.",
  "created_at": "<string>"
}

API documentation

Appointments

Availabilities

Availability Slots

Busy Times

Clients

Contacts

Locations

Practitioners

Services