> ## Documentation Index
> Fetch the complete documentation index at: https://help.elationhealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Recurring Event Groups



## OpenAPI

````yaml get /api/2.0/recurring_event_groups/
openapi: 3.1.0
info:
  contact:
    name: Elation Health
    url: https://www.elationhealth.com/
  description: Elation Health API v2.0
  title: Scheduling API
  version: 2.0.0
servers:
  - description: Sandbox Server
    url: https://sandbox.elationemr.com
  - description: Production Server
    url: https://api.app.elationemr.com
security: []
paths:
  /api/2.0/recurring_event_groups/:
    get:
      tags:
        - Recurring Event Groups
      summary: List Recurring Event Groups
      operationId: recurring_event_groups_list
      parameters:
        - description: >-
            End of range to filter event groups by schedule date. Returns any
            group with schedules that don't start after this date.
          in: query
          name: end_date
          schema:
            type: string
        - description: Number of results to return per page.
          in: query
          name: limit
          required: false
          schema:
            type: integer
        - description: The initial index from which to return the results.
          in: query
          name: offset
          required: false
          schema:
            type: integer
        - description: Which field to use when ordering the results.
          in: query
          name: order_by
          required: false
          schema:
            type: string
        - description: The ids of providers associated with these recurring event groups.
          in: query
          name: physician
          schema:
            items:
              type: string
            type: array
        - description: The practice for these recurring event groups.
          explode: false
          in: query
          name: practice
          schema:
            items:
              format: int64
              type: integer
            type: array
          style: form
        - description: The name of the recurring event group.
          explode: false
          in: query
          name: reason
          schema:
            items:
              type: string
            type: array
          style: form
        - description: >-
            Start of range to filter event groups by schedule date. Returns any
            group with schedules that don't end before this date.
          in: query
          name: start_date
          schema:
            type: string
        - in: query
          name: time_slot_type
          schema:
            enum:
              - appointment
              - appointment_slot
              - event
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedRecurringEventGroupList'
          description: ''
      security:
        - oauth2: []
components:
  schemas:
    PaginatedRecurringEventGroupList:
      properties:
        count:
          example: 123
          type: integer
        next:
          example: http://api.example.org/accounts/?offset=400&limit=100
          format: uri
          nullable: true
          type: string
        previous:
          example: http://api.example.org/accounts/?offset=200&limit=100
          format: uri
          nullable: true
          type: string
        results:
          items:
            $ref: '#/components/schemas/RecurringEventGroup'
          type: array
      required:
        - results
      type: object
    RecurringEventGroup:
      properties:
        created_date:
          format: date-time
          readOnly: true
          type:
            - string
            - 'null'
        deleted_date:
          format: date-time
          readOnly: true
          type:
            - string
            - 'null'
        id:
          readOnly: true
          type: integer
        is_blocking:
          readOnly: true
          type: boolean
        practice:
          format: int64
          type: integer
        reason:
          readOnly: true
          type:
            - string
            - 'null'
        schedules:
          items:
            $ref: '#/components/schemas/RecurringEventSchedule'
          type: array
        time_slot_type:
          $ref: '#/components/schemas/TimeSlotTypeEnum'
      required:
        - practice
        - schedules
        - time_slot_type
      type: object
    RecurringEventSchedule:
      properties:
        created_date:
          format: date-time
          readOnly: true
          type:
            - string
            - 'null'
        description:
          type: string
        dow_friday:
          type: boolean
        dow_monday:
          type: boolean
        dow_saturday:
          type: boolean
        dow_sunday:
          type: boolean
        dow_thursday:
          type: boolean
        dow_tuesday:
          type: boolean
        dow_wednesday:
          type: boolean
        duration:
          type: integer
        event_time:
          format: time
          type: string
        id:
          readOnly: true
          type: integer
        physician:
          format: int64
          type: integer
        repeats:
          $ref: '#/components/schemas/RepeatsEnum'
        series_start:
          format: date
          type: string
        series_stop:
          format: date
          type:
            - string
            - 'null'
      required:
        - duration
        - event_time
        - physician
        - series_start
      type: object
    TimeSlotTypeEnum:
      enum:
        - appointment
        - appointment_slot
        - event
      type: string
    RepeatsEnum:
      enum:
        - Monthly
        - Weekly
      type: string
  securitySchemes:
    oauth2:
      flows:
        clientCredentials:
          scopes:
            act_as_user: >-
              Impersonate a provider via X-On-Behalf-Of (combinable with apiv2
              or system scopes)
            apiv2: Full access to the API
            system/{resource_name}.read: Read access to a specific resource
            system/{resource_name}.write: Write access to a specific resource
          tokenUrl: /api/2.0/oauth2/token/
      type: oauth2

````