v1

latestOpenAPI 3.1.02026-07-24447622848.7 KB
Recurring Event Groups

List Recurring Event Groups

get/api/2.0/recurring_event_groups/

Query parameters

end_datestring

End of range to filter event groups by schedule date. Returns any group with schedules that don't start after this date.

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

order_bystring

Which field to use when ordering the results.

physicianstring[]

The ids of providers associated with these recurring event groups.

practiceinteger[]

The practice for these recurring event groups.

reasonstring[]

The name of the recurring event group.

start_datestring

Start of range to filter event groups by schedule date. Returns any group with schedules that don't end before this date.

time_slot_type'appointment' | 'appointment_slot' | 'event'

Response

countinteger
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}