Actions17
Appointment → Get Free Hours
AI-generatedSummary
Fetch free hour slots for an appointment filtered by insurance plan, service and date range
Inputs
- insurancePlanId (required) — ID of the insurance plan
- serviceId (required) — ID of the service
- startDate (required) — Start date to search for free hours (YYYY-MM-DD)
- endDate (required) — End date to search for free hours (YYYY-MM-DD)
- additionalFields — Additional filters or fields to include
Output shape
a list of free hour records
Each item contains the free hour details returned by the API; default limit is 100 and offset is 0.
Examples
Example 1: Find free hours for an insurance plan and service between two dates
Provide Insurance Plan ID, Service ID, Start Date and End Date (e.g., 2025-09-16 to 2025-09-20); optionally add Professional IDs in Additional Fields.
Example 2: Restrict results to specific professionals
Enter comma‑separated Professional IDs in Additional Fields (e.g., "PROF1,PROF2").