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

# List questionnaire responses

> List questionnaire responses across your organization, filterable by `questionnaire_id`, `status`, `subject`, and `encounter_id` — for example, all completed responses to your refill questionnaire, or every response captured during a given encounter.



## OpenAPI

````yaml /openapi.json get /questionnaire-responses
openapi: 3.1.0
info:
  title: OpenLoop API
  version: 0.1.0
  description: >-
    Unified reference for the OpenLoop Patient (clinical) and Payments & Revenue
    APIs.
servers:
  - url: https://api.openloophealth.com/v0.1
    description: Production partner edge
  - url: https://api-staging.openloophealth.com/v0.1
    description: Staging partner edge (sandbox credentials)
security: []
paths:
  /questionnaire-responses:
    get:
      tags:
        - Questionnaire Responses
      summary: List questionnaire responses
      description: >-
        List questionnaire responses across your organization, filterable by
        `questionnaire_id`, `status`, `subject`, and `encounter_id` — for
        example, all completed responses to your refill questionnaire, or every
        response captured during a given encounter.
      parameters:
        - schema:
            type:
              - string
              - 'null'
            maxLength: 64
          required: false
          name: questionnaire_id
          in: query
        - schema:
            type: string
            enum:
              - in-progress
              - completed
              - amended
              - entered-in-error
              - stopped
          required: false
          name: status
          in: query
        - schema:
            type:
              - string
              - 'null'
            maxLength: 200
          required: false
          name: subject
          in: query
        - schema:
            type:
              - string
              - 'null'
            maxLength: 64
          required: false
          name: encounter_id
          in: query
          description: >-
            Filter to responses captured during this encounter (its bare id).
            Matches the `encounter_id` carried on a response and co-created at
            intake.
        - schema:
            type: string
            maxLength: 2048
            pattern: ^[A-Za-z0-9_-]+$
          required: false
          name: cursor
          in: query
          description: >-
            Opaque pagination token. Pass back the `after` (next page) or
            `before` (previous page) value from a prior response's envelope to
            fetch that page. Do not construct or decode it.
        - schema:
            anyOf:
              - type: integer
              - type: string
                pattern: ^\d+$
          required: false
          name: limit
          in: query
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/QuestionnaireResponse'
                  after:
                    type: string
                    description: >-
                      Forward pagination cursor. Present when more results
                      follow; absent on the last page. To fetch the next page,
                      send this exact value back as the `cursor` query parameter
                      (note the different name) — do not send it as `after`.
                      Opaque; do not construct or decode it.
                  before:
                    type: string
                    description: >-
                      Backward pagination cursor for the previous page, when
                      available. Send this value back as the `cursor` query
                      parameter (same `cursor` param as forward paging; there is
                      no separate `before` parameter). Opaque; do not construct
                      or decode it.
                  request_id:
                    type: string
                required:
                  - items
                  - request_id
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - serviceToken: []
        - userToken: []
components:
  schemas:
    QuestionnaireResponse:
      type: object
      properties:
        id:
          type: string
          maxLength: 64
          pattern: ^[A-Za-z0-9\-.]{1,64}$
        questionnaire_id:
          type: string
          maxLength: 64
        questionnaire_canonical:
          type: string
          maxLength: 2048
        status:
          type: string
          enum:
            - in-progress
            - completed
            - amended
            - entered-in-error
            - stopped
        subject:
          type: object
          properties:
            id:
              type: string
              maxLength: 64
              pattern: ^[A-Za-z0-9\-.]{1,64}$
            type:
              type: string
              minLength: 1
              maxLength: 64
              pattern: ^[A-Z][A-Za-z]+$
          required:
            - id
            - type
        encounter_id:
          type: string
          maxLength: 64
        authored_at:
          type: string
          pattern: >-
            ^\d{4}(?:-\d{2}(?:-\d{2}(?:T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2}))?)?)?$
        author:
          type: object
          properties:
            id:
              type: string
              maxLength: 64
              pattern: ^[A-Za-z0-9\-.]{1,64}$
            type:
              type: string
              minLength: 1
              maxLength: 64
              pattern: ^[A-Z][A-Za-z]+$
          required:
            - id
            - type
        source:
          type: object
          properties:
            id:
              type: string
              maxLength: 64
              pattern: ^[A-Za-z0-9\-.]{1,64}$
            type:
              type: string
              minLength: 1
              maxLength: 64
              pattern: ^[A-Z][A-Za-z]+$
          required:
            - id
            - type
        answers:
          type: object
          additionalProperties:
            anyOf:
              - type: object
                properties:
                  value_boolean:
                    type: boolean
                required:
                  - value_boolean
              - type: object
                properties:
                  value_decimal:
                    type: number
                required:
                  - value_decimal
              - type: object
                properties:
                  value_integer:
                    type: integer
                required:
                  - value_integer
              - type: object
                properties:
                  value_date:
                    type: string
                    pattern: ^\d{4}-\d{2}-\d{2}$
                required:
                  - value_date
              - type: object
                properties:
                  value_date_time:
                    type: string
                    pattern: >-
                      ^\d{4}(?:-\d{2}(?:-\d{2}(?:T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2}))?)?)?$
                required:
                  - value_date_time
              - type: object
                properties:
                  value_time:
                    type: string
                    pattern: ^([01][0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9](\.\d+)?)?$
                required:
                  - value_time
              - type: object
                properties:
                  value_string:
                    type: string
                    maxLength: 10000
                required:
                  - value_string
              - type: object
                properties:
                  value_uri:
                    type: string
                    maxLength: 2048
                    format: uri
                required:
                  - value_uri
              - type: object
                properties:
                  value_coding:
                    type: object
                    properties:
                      system:
                        type: string
                        format: uri
                      code:
                        type: string
                        minLength: 1
                      display:
                        type: string
                        maxLength: 500
                    required:
                      - code
                required:
                  - value_coding
              - type: object
                properties:
                  value_reference:
                    type: object
                    properties:
                      id:
                        type: string
                        maxLength: 64
                        pattern: ^[A-Za-z0-9\-.]{1,64}$
                      type:
                        type: string
                        minLength: 1
                        maxLength: 64
                        pattern: ^[A-Z][A-Za-z]+$
                    required:
                      - id
                      - type
                required:
                  - value_reference
              - type: object
                properties:
                  value_quantity:
                    type: object
                    properties:
                      value:
                        type: number
                      unit:
                        type: string
                        maxLength: 64
                      system:
                        type: string
                        format: uri
                      code:
                        type: string
                        maxLength: 64
                    required:
                      - value
                required:
                  - value_quantity
              - type: array
                items:
                  anyOf:
                    - type: object
                      properties:
                        value_boolean:
                          type: boolean
                      required:
                        - value_boolean
                    - type: object
                      properties:
                        value_decimal:
                          type: number
                      required:
                        - value_decimal
                    - type: object
                      properties:
                        value_integer:
                          type: integer
                      required:
                        - value_integer
                    - type: object
                      properties:
                        value_date:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2}$
                      required:
                        - value_date
                    - type: object
                      properties:
                        value_date_time:
                          type: string
                          pattern: >-
                            ^\d{4}(?:-\d{2}(?:-\d{2}(?:T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2}))?)?)?$
                      required:
                        - value_date_time
                    - type: object
                      properties:
                        value_time:
                          type: string
                          pattern: >-
                            ^([01][0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9](\.\d+)?)?$
                      required:
                        - value_time
                    - type: object
                      properties:
                        value_string:
                          type: string
                          maxLength: 10000
                      required:
                        - value_string
                    - type: object
                      properties:
                        value_uri:
                          type: string
                          maxLength: 2048
                          format: uri
                      required:
                        - value_uri
                    - type: object
                      properties:
                        value_coding:
                          type: object
                          properties:
                            system:
                              type: string
                              format: uri
                            code:
                              type: string
                              minLength: 1
                            display:
                              type: string
                              maxLength: 500
                          required:
                            - code
                      required:
                        - value_coding
                    - type: object
                      properties:
                        value_reference:
                          type: object
                          properties:
                            id:
                              type: string
                              maxLength: 64
                              pattern: ^[A-Za-z0-9\-.]{1,64}$
                            type:
                              type: string
                              minLength: 1
                              maxLength: 64
                              pattern: ^[A-Z][A-Za-z]+$
                          required:
                            - id
                            - type
                      required:
                        - value_reference
                    - type: object
                      properties:
                        value_quantity:
                          type: object
                          properties:
                            value:
                              type: number
                            unit:
                              type: string
                              maxLength: 64
                            system:
                              type: string
                              format: uri
                            code:
                              type: string
                              maxLength: 64
                          required:
                            - value
                      required:
                        - value_quantity
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - status
        - answers
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            error_code:
              type: string
          required:
            - message
            - error_code
        request_id:
          type: string
      required:
        - error
        - request_id
  securitySchemes:
    serviceToken:
      type: oauth2
      description: >-
        Service (M2M) access token issued by POST /auth/token using the
        client_credentials grant. Required scopes, where known, are listed on
        each operation below.
      flows:
        clientCredentials:
          tokenUrl: https://api.openloophealth.com/v0.1/auth/token
          scopes: {}
    userToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        User access token issued by POST /auth/token via the verification-code
        grant (after Verify a one-time code) or the refresh_token grant.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.