ENendless
admin
patient-appointments

List Patient Appointments

List patient appointments with flexible filtering.

Access control:

  • Staff: Can view appointments within their organization (automatically filtered)
  • Coaches: Can view appointments for their assigned patients only
  • Superusers: Can view all appointments
get/api/v3/admin/patient-appointments/

Request

  • Base URL
    https://api.endless.health (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Query parameters

user_idinteger nullable

Filter by patient user_id

coach_idinteger nullable

Filter by coach_id

organization_idinteger nullable

Filter by organization_id

start_timestring date-time nullable

Filter from this start time. Can be combined with time_frame.

end_timestring date-time nullable

Filter until this end time. Can be combined with time_frame.

statusstring nullable

Filter by appointment status

time_frame'PAST' | 'UPCOMING'

Time frame filters for appointments.

  • PAST: Appointments where end_time < now (the appointment has ended)
  • UPCOMING: Appointments where end_time >= now (the appointment hasn't ended yet)

Filter by time frame: 'upcoming' (end_time >= now) or 'past' (end_time < now). Can be combined with start_time and end_time for additional filtering.

limitinteger

Maximum number of results

offsetinteger

Number of results to skip

Response

Successful Response

coach_idinteger required
start_timestring date-time nullable
end_timestring date-time nullable
timezonestring nullable
is_availableboolean
status'SCHEDULED' | 'CANCELED' | 'NOT_ATTENDED' | 'RESCHEDULED'
titlestring nullable
descriptionstring nullable
locationstring nullable
is_recurringboolean
recurrence_rulestring nullable
max_bookingsinteger nullable
booking_durationinteger nullable
notesstring nullable
idinteger required
user_idinteger required
external_calendar_idstring nullable
external_event_idstring nullable
meeting_linkstring nullable
cancel_linkstring nullable
reschedule_linkstring nullable
coach_namestring nullable
session_numberinteger nullable
upcoming_session_statusstring nullable
attendedboolean nullable
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.