> ## 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 Incoming Files



## OpenAPI

````yaml get /api/2.0/incoming_files/
openapi: 3.1.0
info:
  contact:
    name: Elation Health
    url: https://www.elationhealth.com/
  description: Elation Health API v2.0
  title: Patient Document 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/incoming_files/:
    get:
      tags:
        - Incoming Files
      summary: List Incoming Files
      operationId: incoming_files_list
      parameters:
        - in: query
          name: created_date__gte
          schema:
            format: date-time
            type: string
        - in: query
          name: created_date__lte
          schema:
            format: date-time
            type: string
        - in: query
          name: from_number
          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: Multiple values may be separated by commas.
          explode: false
          in: query
          name: practice
          schema:
            items:
              format: int64
              type: integer
            type: array
          style: form
        - in: query
          name: practice_fax
          schema:
            type: string
        - description: |-
            * `complete` - complete
            * `error` - error
            * `processing` - processing
          in: query
          name: process_state
          schema:
            enum:
              - complete
              - error
              - processing
            type: string
        - in: query
          name: received_time__gte
          schema:
            format: date-time
            type: string
        - in: query
          name: received_time__lte
          schema:
            format: date-time
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedIncomingFileGroupList'
          description: ''
      security:
        - oauth2: []
components:
  schemas:
    PaginatedIncomingFileGroupList:
      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/IncomingFileGroup'
          type: array
      required:
        - results
      type: object
    IncomingFileGroup:
      properties:
        created_date:
          format: date-time
          readOnly: true
          type:
            - string
            - 'null'
        external_fax_id:
          type:
            - string
            - 'null'
        file_size:
          readOnly: true
          type:
            - integer
            - 'null'
        files:
          items:
            $ref: '#/components/schemas/File'
          type:
            - array
            - 'null'
        from_number:
          readOnly: true
          type:
            - string
            - 'null'
        group_name:
          maxLength: 200
          type: string
        id:
          readOnly: true
          type: integer
        images:
          items:
            $ref: '#/components/schemas/Image'
          type:
            - array
            - 'null'
        page_count:
          readOnly: true
          type:
            - integer
            - 'null'
        practice:
          format: int64
          type: integer
        practice_fax:
          type:
            - string
            - 'null'
        process_complete_time:
          format: date-time
          type:
            - string
            - 'null'
        process_result:
          readOnly: true
          type:
            - string
            - 'null'
        process_start_time:
          format: date-time
          type:
            - string
            - 'null'
        process_state:
          allOf:
            - $ref: '#/components/schemas/ProcessStateEnum'
          readOnly: true
        received_time:
          format: date-time
          type:
            - string
            - 'null'
        source:
          allOf:
            - $ref: '#/components/schemas/SourceEnum'
          readOnly: true
        subject:
          readOnly: true
          type:
            - string
            - 'null'
        to_company:
          readOnly: true
          type:
            - string
            - 'null'
        to_name:
          readOnly: true
          type:
            - string
            - 'null'
        to_number:
          readOnly: true
          type:
            - string
            - 'null'
        transmit_time:
          format: date-time
          type:
            - string
            - 'null'
      required:
        - group_name
        - practice
      type: object
    File:
      properties:
        base64_content:
          type: string
          writeOnly: true
        content_type:
          maxLength: 200
          type: string
        created_date:
          format: date-time
          readOnly: true
          type:
            - string
            - 'null'
        deleted_date:
          format: date-time
          readOnly: true
          type:
            - string
            - 'null'
        file_size:
          readOnly: true
          type:
            - integer
            - 'null'
        file_url:
          readOnly: true
          type: string
        filename:
          type: string
        id:
          readOnly: true
          type: integer
        incoming_file:
          type: integer
        practice:
          format: int64
          type:
            - integer
            - 'null'
      required:
        - base64_content
        - content_type
        - filename
      type: object
    Image:
      properties:
        base64_content:
          type: string
          writeOnly: true
        content_type:
          type: string
          writeOnly: true
        created_date:
          format: date-time
          readOnly: true
          type:
            - string
            - 'null'
        deleted_date:
          format: date-time
          readOnly: true
          type:
            - string
            - 'null'
        file_size:
          readOnly: true
          type:
            - integer
            - 'null'
        height:
          readOnly: true
          type:
            - integer
            - 'null'
        id:
          readOnly: true
          type: integer
        image_url:
          readOnly: true
          type: string
        incoming_file:
          type: integer
        original_extension:
          maxLength: 10
          type: string
        original_height:
          type: integer
        original_padded:
          type: integer
        original_rotation:
          type: integer
        original_width:
          type: integer
        practice:
          format: int64
          type:
            - integer
            - 'null'
        quality_score:
          readOnly: true
          type:
            - integer
            - 'null'
        quality_score_by:
          readOnly: true
          type:
            - integer
            - 'null'
        received_date:
          format: date-time
          type: string
        rotation:
          readOnly: true
          type: integer
        sequence:
          readOnly: true
          type:
            - integer
            - 'null'
        width:
          readOnly: true
          type:
            - integer
            - 'null'
      required:
        - base64_content
        - content_type
      type: object
    ProcessStateEnum:
      enum:
        - complete
        - error
        - pending
        - processing
      type: string
    SourceEnum:
      enum:
        - metrofax
        - plr
        - refile
        - softlinx
        - user
      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

````