Skip to main content
​
id
string

The appointment client's unique identifier.

Example:

"apc_01HQFQ9QWTNNPY58FZ8CB3FWWK"

​
appointment_id
string

The appointment identifier.

Example:

"apt_01HQFQ9QWTNNPY58FZ8CB3FWWK"

​
client_id
string

The client identifier.

Example:

"cli_01HQFQ9QWTNNPY58FZ8CB3FWWK"

​
case_id
string | null

The case identifier for this client's booking.

Example:

"cas_01HQFQ9QWTNNPY58FZ8CB3FWWK"

​
client_package_id
string | null

The client package identifier if this booking uses a package.

Example:

"cpk_01HQFQ9QWTNNPY58FZ8CB3FWWK"

​
status
enum<string> | null

The attendance status of the client.

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

"arrived"

​
do_not_invoice
boolean

Whether this client should not be invoiced for this appointment.

Example:

false

​
note
string | null

Notes specific to this client's appointment.

Example:

"Client requested extra time"

​
confirmed
boolean

Whether the client has confirmed their attendance.

Example:

true

​
confirmed_at
string | null

When the client confirmed their attendance (ISO 8601).

Example:

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

​
cancellation_reason_id
string | null

The cancellation reason identifier if cancelled.

Example:

"cnr_01HQFQ9QWTNNPY58FZ8CB3FWWK"

​
cancellation_note
string | null

Additional notes about the cancellation.

Example:

"Client called to cancel"

​
cancelled_at
string | null

When this client's appointment was cancelled (ISO 8601).

Example:

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

​
starts_at
string

The appointment start time (ISO 8601).

Example:

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

​
ends_at
string

The appointment end time (ISO 8601).

Example:

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

​
created_at
string

The timestamp when this record was created (ISO 8601).

Example:

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

​
updated_at
string

The timestamp when this record was last updated (ISO 8601).

Example:

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