Skip to content
HeyX API

List Available Appointment Slots

Required scope: appointment:read

Lists bookable start and end windows on a direct-scheduling agenda for one calendar day. dateYmd is YYYY-MM-DD in the agenda’s timezone. The agenda and appointment type must be active and support direct scheduling. Omitting durationMinutes or passing 0 uses the appointment type’s default duration. Optionally restrict availability to one memberId.

This does not reserve a slot; use Create Appointment to book one.

Generated Reference
POST /public-api/publicapi.v1.Appointment/ListAvailableAppointmentSlots

Lists bookable start times for one active agenda on one local calendar day and appointment type. Manual-routing agendas are not bookable this way.

Request ListAvailableAppointmentSlotsRequest
Response ListAvailableAppointmentSlotsResponse

ListAvailableAppointmentSlotsRequest

Field Type Description
agenda_id string Agenda to compute availability for.
date_ymd string Local calendar day in the agenda's timezone, formatted YYYY-MM-DD.
appointment_type_id string Appointment type whose duration rules apply to the returned slots.
duration_minutes int32 Slot length in minutes; zero uses the appointment type default.
member_id optional string Restrict availability to one member eligible for the agenda.

ListAvailableAppointmentSlotsResponse

Field Type Description
slots repeated AvailableSlot Bookable slots for the requested agenda and day.

Related Types

AvailableSlot

Field Type Description
scheduled_start_at int64 Slot start as unix seconds.
scheduled_end_at int64 Slot end as unix seconds. 
{
  "agendaId": "<agenda-id>",
  "dateYmd": "2026-02-01",
  "appointmentTypeId": "<appointment-type-id>",
  "durationMinutes": 60
}
HeyX API