Skip to main content
id
string

The appointment's unique identifier.

location_id
string

The location identifier where the appointment takes place.

practitioner_id
string

The practitioner identifier who provides the service.

service_id
string

The service identifier being provided.

client_id
string

The client identifier who has the appointment.

client_package_id
string | null

The client package identifier if this appointment uses a package.

Example:

"cpk_01HQFQ9QWTNNPY58FZ8CB3FWWK"

case_id
string | null

The case identifier if this appointment is part of a case.

Example:

"cas_01HQFQ9QWTNNPY58FZ8CB3FWWK"

starts_at
string

The appointment start time (ISO 8601).

ends_at
string

The appointment end time (ISO 8601).

duration
integer

The appointment duration in minutes.

status
string

The appointment status.

confirmed
boolean | null

Whether the appointment is confirmed.

Example:

true

confirmed_at
string | null

When the appointment was confirmed (ISO 8601).

Example:

"2024-01-01T09:30:00Z"

room_id
string | null

The room identifier where the appointment takes place.

Example:

"rom_01HQFQ9QWTNNPY58FZ8CB3FWWK"

vehicle_id
string | null

The vehicle identifier if transportation is involved.

Example:

"veh_01HQFQ9QWTNNPY58FZ8CB3FWWK"

resource_ids
string[]

The IDs of resources required for this appointment.

note
string | null

The appointment note.

Example:

"Client requested morning appointment."

cancellation_reason_id
string | null

The cancellation reason identifier if cancelled.

Example:

"cnr_01HQFQ9QWTNNPY58FZ8CB3FWWK"

cancellation_note
string | null

The cancellation note if cancelled.

Example:

"Client had to travel unexpectedly."

cancelled_at
string | null

When the appointment was cancelled (ISO 8601).

Example:

"2024-01-01T08:00:00Z"

created_at
string

The timestamp when the appointment was created (ISO 8601).