Skip to main content
GET
cURL

Path Parameters

appointment
string
required

The appointment ID

Response

AppointmentResource

id
string

The appointment's unique identifier.

Example:

"app_01HQFQ9QWTNNPY58FZ8CB3FWWK"

location_id
string

The location identifier where the appointment takes place.

Example:

"loc_01HQFQ9QWTNNPY58FZ8CB3FWWK"

practitioner_id
string

The practitioner identifier who provides the service.

Example:

"pra_01HQFQ9QWTNNPY58FZ8CB3FWWK"

service_id
string

The service identifier being provided.

Example:

"ser_01HQFQ9QWTNNPY58FZ8CB3FWWK"

service_price
integer

The snapshotted base price from the service at time of booking.

Example:

12000

price
integer

The calculated total price (service_price × client count if price_per_client).

Example:

24000

price_unit
enum<string>

The snapshotted price unit from the service at time of booking.

Available options:
hourly,
fixed
Example:

"hourly"

price_per_client
boolean

Whether the price is per client (true) or per appointment (false).

Example:

false

travel
boolean

Whether billable travel time applies to this appointment.

Example:

true

travel_name
string | null

The snapshotted travel line item name.

Example:

"Travel"

travel_price
integer | null

The snapshotted flat travel price in cents.

Example:

5000

travel_before_duration
integer | null

The billable travel time before the appointment in minutes.

Example:

15

travel_after_duration
integer | null

The billable travel time after the appointment in minutes.

Example:

15

travel_address
string | null

The travel destination address (single-line, free text).

Example:

"123 Sample Street, Sydney NSW 2000, Australia"

travel_expenses
AppointmentTravelExpenseResource · object[]

The travel expense line items (when loaded).

transports
AppointmentTransportResource · object[]

The transport line items (when loaded).

appointment_clients
AppointmentClientResource · object[]

The appointment clients (when loaded).

starts_at
string

The appointment start time (ISO 8601).

Example:

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

ends_at
string

The appointment end time (ISO 8601).

Example:

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

duration
integer

The appointment duration in minutes.

Example:

60

status
enum<string>

The appointment status.

Available options:
pending,
arrived,
missed,
cancelled
Example:

"pending"

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.

Example:
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"

archived_at
string | null

When the appointment was archived (ISO 8601).

Example:

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

created_at
string

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

Example:

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