Find Available Times

Component Details

v1.0.0

Basic Information

appmixer.cliniko.core.FindAvailableTimes

Find Available Times

1.0.0

Public

Finds the bookable appointment start times for a practitioner at a business, for a given appointment type, within a date window. The business, practitioner and appointment type must all be enabled for online bookings in Cliniko - otherwise the endpoint answers 404. Cliniko allows a window of at most 7 days and will not look into the past.

Input Ports

in

FieldTypeDescription
Business text Start typing to pick a business (clinic location), or enter a Business ID directly.
Practitioner text Start typing to pick a practitioner, or enter a Practitioner ID directly.
Appointment Type text Start typing to pick an appointment type, or enter an Appointment Type ID directly.
From date-time First day of the window. Leave empty for today. Must not be earlier than today in the account time zone.
To date-time Last day of the window. Leave empty for 6 days after From - Cliniko allows at most 7 days between From and To.
Output Type select Choose whether you want to receive the result set as one complete list, first item only, one item at a time, or stream the items to a file.

Output Ports

out

Dynamic variables loaded from /component/appmixer/cliniko/core/FindAvailableTimes?outPort=out&ignoreAuth=true

notFound

FieldTypeDescription
No fields defined for this port

Full Metadata