Skip to main content
​
id
string

The availability's unique identifier.

Example:

"ava_01HZR88VXZ3G2NTVPEB2PCCKDY"

​
created_at
string

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

Example:

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

​
date
string

The availability date (ISO 8601).

Example:

"2025-09-22"

​
day
string

The day of the week abbreviation.

Example:

"mon"

​
end_time
string

The end time in 24-hour format.

Example:

"17:00"

​
location_id
string

The location's unique identifier.

Example:

"loc_01HZR88VXZ3G2NTVPEB2PCCKDY"

​
practitioner_id
string

The practitioner's unique identifier.

Example:

"pra_01HWPZ5P0ENVS5W7ZFAS0DW5PT"

​
repeating
boolean

Whether this availability repeats.

Example:

true

​
repeating_end_date
string | null

The end date for repeating availability (ISO 8601).

Example:

"2025-12-31"

​
repeating_interval
string | null

The repeating interval type.

Example:

"weekly"

​
start_time
string

The start time in 24-hour format.

Example:

"09:00"