HearLink icon

HearLink

Create HearLink patients and appointments, and retrieve HearLink records

Actions7

Booking → Get Monthly Availability

AI-generated

Summary

Fetch monthly booking availability for a clinic and appointment type.

Inputs

  • simplifyOutput — Whether to return only the HearLink data payload instead of the full API response envelope
  • organizationId (required) — The public HearLink organization ID
  • clinicId (required) — The public HearLink clinic ID
  • appointmentTypeId (required) — The public HearLink appointment type ID
  • date (required) — The date to query in YYYY-MM-DD format. For monthly availability, HearLink uses this as the anchor date for the month response.

Output shape

an object representing the monthly availability data for the specified clinic and appointment type

If simplifyOutput is false, the full API response envelope is returned; otherwise only the data payload is returned. The exact shape depends on HearLink's response.

Examples

Example 1: Get May 2026 availability for a clinic

organizationId=org123&clinicId=clinic456&appointmentTypeId=type789&date=2026-05-01&simplifyOutput=true

Links

Discussion