The appointment object

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

string

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

Example:

"hourly"

price_per_client

boolean

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

Example:

false

appointment_clients

AppointmentClientResource · object[]

The appointment clients (when loaded).

Show child attributes

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

string

The appointment status.

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:

[
  "res_01HYHYQHA682J0K1RW7B2HVA9F",
  "res_01HYHYW37MTYJPMT5JV4RN99GK"
]

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).

Example:

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

List all appointments

{
  "id": "<string>",
  "location_id": "<string>",
  "practitioner_id": "<string>",
  "service_id": "<string>",
  "service_price": 123,
  "price": 123,
  "price_unit": "<string>",
  "price_per_client": true,
  "appointment_clients": [
    {
      "id": "<string>",
      "appointment_id": "<string>",
      "client_id": "<string>",
      "case_id": "cas_01HQFQ9QWTNNPY58FZ8CB3FWWK",
      "client_package_id": "cpk_01HQFQ9QWTNNPY58FZ8CB3FWWK",
      "status": "attended",
      "do_not_invoice": true,
      "note": "Client requested extra time",
      "confirmed": true,
      "confirmed_at": "2024-01-01T12:00:00Z",
      "cancellation_reason_id": "cnr_01HQFQ9QWTNNPY58FZ8CB3FWWK",
      "cancellation_note": "Client called to cancel",
      "cancelled_at": "2024-01-01T12:00:00Z",
      "starts_at": "<string>",
      "ends_at": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "starts_at": "<string>",
  "ends_at": "<string>",
  "duration": 123,
  "status": "<string>",
  "room_id": "rom_01HQFQ9QWTNNPY58FZ8CB3FWWK",
  "vehicle_id": "veh_01HQFQ9QWTNNPY58FZ8CB3FWWK",
  "resource_ids": [
    "<string>"
  ],
  "note": "Client requested morning appointment.",
  "cancellation_reason_id": "cnr_01HQFQ9QWTNNPY58FZ8CB3FWWK",
  "cancellation_note": "Client had to travel unexpectedly.",
  "cancelled_at": "2024-01-01T08:00:00Z",
  "created_at": "<string>"
}

API documentation

Appointments

Availabilities

Availability Slots

Clients

Contacts

Locations

Practitioners

Services