Find Appointments

Component Details

v1.0.0

Basic Information

appmixer.cliniko.core.FindAppointments

Find Appointments

1.0.0

Public

Searches individual (one-on-one) appointments by date range, patient, practitioner or business. Returns up to 100 appointments (one page at the maximum page size).

Input Ports

in

FieldTypeDescription
Patient text Start typing to search your patients, or enter a Patient ID directly.
Practitioner text Start typing to pick a practitioner, or enter a Practitioner ID directly.
Business text Start typing to pick a business (clinic location), or enter a Business ID directly.
Starts After date-time Only appointments starting at or after this moment.
Starts Before date-time Only appointments starting at or before this moment.
Created After date-time Only appointments created at or after this moment.
Updated After date-time Only appointments updated at or after this moment.
Include Cancelled toggle Cancelled appointments are excluded unless this is turned on.
Include Archived toggle Archived appointments are excluded unless this is turned on.
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/FindAppointments?outPort=out&ignoreAuth=true

notFound

FieldTypeDescription
No fields defined for this port

Full Metadata