> ## 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 Message Threads



## OpenAPI

````yaml get /api/2.0/message_threads/
openapi: 3.1.0
info:
  contact:
    name: Elation Health
    url: https://www.elationhealth.com/
  description: Elation Health API v2.0
  title: Messaging 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/message_threads/:
    get:
      tags:
        - Message Threads
      summary: List Message Threads
      operationId: message_threads_list
      parameters:
        - in: query
          name: document_date__gt
          schema:
            format: date-time
            type: string
        - in: query
          name: document_date__gte
          schema:
            format: date-time
            type: string
        - in: query
          name: document_date__lt
          schema:
            format: date-time
            type: string
        - in: query
          name: document_date__lte
          schema:
            format: date-time
            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: Multiple values may be separated by commas.
          explode: false
          in: query
          name: patient
          schema:
            items:
              format: int64
              type: integer
            type: array
          style: form
        - description: Multiple values may be separated by commas.
          explode: false
          in: query
          name: practice
          schema:
            items:
              format: int64
              type: integer
            type: array
          style: form
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedMessageThreadList'
          description: ''
      security:
        - oauth2: []
components:
  schemas:
    PaginatedMessageThreadList:
      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/MessageThread'
          type: array
      required:
        - results
      type: object
    MessageThread:
      properties:
        chart_date:
          description: When the message thread's patient chart was created.
          format: date-time
          type: string
        created_date:
          description: When the message thread was created.
          format: date-time
          readOnly: true
          type:
            - string
            - 'null'
        deleted_date:
          description: When the message thread was deleted.
          format: date-time
          readOnly: true
          type:
            - string
            - 'null'
        delivery_date:
          format: date-time
          type:
            - string
            - 'null'
        document_date:
          description: When the message thread's document was created.
          format: date-time
          type: string
        id:
          readOnly: true
          type: integer
        is_urgent:
          default: false
          description: Whether the message is currently urgent.
          type: boolean
        members:
          description: >-
            List of Thread Members, when creating only need to specify the id of
            the thread member and their status.
          items:
            $ref: '#/components/schemas/ThreadMember'
          type: array
        messages:
          description: >-
            List of Thread Messages, when creating only need to provide the
            body, send_date and sender.
          items:
            $ref: '#/components/schemas/ThreadMessage'
          type: array
        patient:
          description: The patient chart for which the thread is about.
          format: int64
          type: integer
        practice:
          description: The id of the practice that owns the patient chart.
          format: int64
          type: integer
        signed_by:
          description: The user who signed the thread
          format: int64
          type:
            - integer
            - 'null'
        signed_date:
          description: The date and time when the thread was signed
          format: date-time
          type:
            - string
            - 'null'
      required:
        - chart_date
        - document_date
        - patient
        - practice
      type: object
    ThreadMember:
      properties:
        ack_time:
          description: The time at which the member acknowledged the message thread.
          format: date-time
          type: string
        group:
          description: >-
            The id of the group referenced by this thread member. Should only
            ever be one of either a user or group set for the thread member.
          format: int64
          type:
            - integer
            - 'null'
        id:
          readOnly: true
          type: integer
        status:
          allOf:
            - $ref: '#/components/schemas/ThreadMemberStatusEnum'
          description: Whether this member has acknowledged the message thread.
        thread:
          description: The id of the thread this thread member is a member of.
          format: int64
          type: integer
        user:
          description: >-
            The id of the user referenced by this thread member. Should only
            ever be one of either a user or group set for the thread member.
          type:
            - integer
            - 'null'
      required:
        - status
      type: object
    ThreadMessage:
      properties:
        body:
          description: The actual message body.
          type: string
        id:
          readOnly: true
          type: integer
        patient:
          description: The patient id.
          format: int64
          readOnly: true
          type: integer
        practice:
          description: The practice id.
          format: int64
          readOnly: true
          type: integer
        send_date:
          description: The date of when the message was sent.
          format: date-time
          type: string
        sender:
          description: The id of who sent the message.
          type: integer
        thread:
          description: The message thread id.
          format: int64
          type: integer
        to_document:
          $ref: '#/components/schemas/Document'
      required:
        - body
        - send_date
        - sender
      type: object
    ThreadMemberStatusEnum:
      enum:
        - Addressed
        - Requiring Action
      type: string
    Document:
      properties:
        authoring_practice:
          format: int64
          type: integer
        chart_date:
          description: The creation date of the patient chart.
          format: date-time
          type: string
        created_date:
          description: The creation date of the document.
          format: date-time
          readOnly: true
          type:
            - string
            - 'null'
        deleted_date:
          description: The deleted date of the document.
          format: date-time
          readOnly: true
          type:
            - string
            - 'null'
        document_date:
          description: >-
            The date of the document. In most cases it's the same as the
            creation date. For some documents, like visit notes, it's the date
            of the visit note.
          format: date-time
          type: string
        document_type:
          readOnly: true
          type:
            - integer
            - 'null'
        id:
          format: int64
          type: integer
        last_modified:
          format: date-time
          type: string
        patient:
          format: int64
          type: integer
        sign_date:
          description: The date of when the document was signed (if signed).
          format: date-time
          readOnly: true
          type:
            - string
            - 'null'
        signed_by:
          description: The id of whoever signed the document (if signed).
          readOnly: true
          type: integer
      required:
        - authoring_practice
        - chart_date
        - document_date
        - id
        - patient
      type: object
  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

````