> ## 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 Notes

> Returns a paginated list of note metadata



## OpenAPI

````yaml get /notes
openapi: 3.1.0
info:
  title: Visit Notes API
  description: This API supports the management of visit notes.
  version: 0.1.0
servers:
  - url: https://sandbox.elationemr.com/api/2.0
    description: Sandbox Environment
security: []
paths:
  /notes:
    get:
      tags:
        - Notes
      summary: List Notes
      description: Returns a paginated list of note metadata
      operationId: list_notes
      parameters:
        - description: Limit for pagination
          in: query
          name: limit
          required: false
          schema:
            default: 20
            description: Limit for pagination
            maximum: 100
            minimum: 1
            title: Limit
            type: integer
        - description: Offset for pagination
          in: query
          name: offset
          required: false
          schema:
            default: 0
            description: Offset for pagination
            title: Offset
            type: integer
        - description: Filter by practice ID
          in: query
          name: practice_id
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: Filter by practice ID
            title: Practice Id
        - description: >-
            True to filter to draft notes only. False to include only signed
            notes. Omit to include both.
          in: query
          name: is_draft
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              True to filter to draft notes only. False to include only signed
              notes. Omit to include both.
            title: Is Draft
        - description: Filter by patient ID
          in: query
          name: patient
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: Filter by patient ID
            title: Patient
        - description: Comma separated list of provider IDs
          in: query
          name: providers
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Comma separated list of provider IDs
            title: Providers
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_NoteMetadata_'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - RequireAuthentication: []
        - RequirePracticeAuthorization: []
components:
  schemas:
    PaginatedResponse_NoteMetadata_:
      properties:
        count:
          title: Count
          type: integer
        limit:
          title: Limit
          type: integer
        next:
          anyOf:
            - type: string
            - type: 'null'
          title: Next
        offset:
          title: Offset
          type: integer
        previous:
          anyOf:
            - type: string
            - type: 'null'
          title: Previous
        results:
          items:
            $ref: '#/components/schemas/NoteMetadata'
          title: Results
          type: array
      required:
        - results
        - count
        - offset
        - limit
      title: PaginatedResponse[NoteMetadata]
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    NoteMetadata:
      description: >-
        A lightweight version of `Note` that omits certain fields for
        performance reasons,

        specifically for use with endpoints that return notes in bulk.
      properties:
        bill:
          anyOf:
            - type: integer
            - type: 'null'
          description: ID of the bill associated to the note
          title: Bill
        category:
          description: >-
            Practice-created identifiers for note category.

            A category is a Visit Note Type object.

            See https://docs.elationhealth.com/reference/visit_note_types_list
            for API to list all available categories.
          title: Category
          type: integer
        confidential:
          default: false
          description: Whether the note is marked as confidential.
          title: Confidential
          type: boolean
        doctags:
          default: []
          items:
            $ref: '#/components/schemas/Doctag'
          title: Doctags
          type: array
        id:
          title: Id
          type: integer
        is_draft:
          title: Is Draft
          type: boolean
        metadata:
          anyOf:
            - {}
            - type: 'null'
          description: >-
            An optional field to store any necessary metadata related to the
            note.
          title: Metadata
        note_v1_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Note V1 Id
        patient:
          description: The ID of the patient for whom the note was created.
          title: Patient
          type: integer
        practice:
          description: Authoring practice ID.
          title: Practice
          type: integer
        provider:
          description: The ID of the assigned provider.
          title: Provider
          type: integer
        serviced_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Serviced At
      required:
        - id
        - provider
        - practice
        - patient
        - category
        - serviced_at
        - is_draft
      title: NoteMetadata
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    Doctag:
      description: |-
        A doctag is an identifier that can be applied to a document.
        This implementation of doctag mirrors VN1's coded document tag
      properties:
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
        code_type:
          anyOf:
            - $ref: '#/components/schemas/CODE_TYPE'
            - type: 'null'
        concept_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Concept Name
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        id:
          title: Id
          type: integer
        is_cpc_plus:
          title: Is Cpc Plus
          type: boolean
        is_mips:
          title: Is Mips
          type: boolean
        practice:
          anyOf:
            - type: integer
            - type: 'null'
          title: Practice
        shared:
          title: Shared
          type: boolean
        snomed_result_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Snomed Result Code
        value:
          title: Value
          type: string
      required:
        - value
        - id
        - shared
        - is_mips
        - is_cpc_plus
      title: Doctag
      type: object
    CODE_TYPE:
      enum:
        - CPT
        - SNOMED
        - HL7
        - ICD9
        - LOINC
        - CVX
        - RXNORM
        - ICD10
        - CPTII
        - HCPCS
        - EL8
      title: CODE_TYPE
      type: string
  securitySchemes:
    RequireAuthentication:
      type: http
      scheme: bearer
    RequirePracticeAuthorization:
      type: http
      scheme: bearer

````