Skip to main content
id
string

The service's unique identifier.

Example:

"ser_01HQFQ9QWTNNPY58FZ8CB3FWWK"

category_id
string

The service category identifier.

Example:

"cat_01HQFQ9QWTNNPY58FZ8CB3FWWK"

progress_note_template_id
string | null

The progress note template identifier.

Example:

"pnt_01HQFQ9QWTNNPY58FZ8CB3FWWK"

appointment_notification_set_id
string | null

The appointment notification set identifier.

Example:

"ans_01HQFQ9QWTNNPY58FZ8CB3FWWK"

tax_id
string

The tax identifier.

Example:

"tax_01HQFQ9QWTNNPY58FZ8CB3FWWK"

name
string

The service's name.

Example:

"Initial Consultation"

description
string | null

The service's description.

Example:

"Comprehensive initial assessment and treatment planning session."

item_code
string | null

The service's item code.

Example:

"IC001"

duration
integer

The service duration in minutes.

Example:

60

buffer_before_duration
integer

The buffer time before the service in minutes.

Example:

5

buffer_after_duration
integer

The buffer time after the service in minutes.

Example:

10

price
number

The service price.

Example:

150

price_unit
string

The service price unit.

Example:

"per_session"

online_booking
boolean

Whether online booking is enabled for this service.

Example:

true

practitioner_ids
string[]

The IDs of practitioners who can provide this service.

Example:
[
"pra_01HYHYQHA682J0K1RW7B2HVA9F",
"pra_01HYHYW37MTYJPMT5JV4RN99GK"
]
location_ids
string[]

The IDs of locations where this service is available.

Example:
[
"loc_01HYHYQHA682J0K1RW7B2HVA9F",
"loc_01HYHYW37MTYJPMT5JV4RN99GK"
]
tag_ids
string[]

The IDs of tags attached to this service.

Example:
[
"tag_01HYHYQHA682J0K1RW7B2HVA9F",
"tag_01HYHYW37MTYJPMT5JV4RN99GK"
]
created_at
string

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

Example:

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