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

# List Interviews

> List interview summaries with pagination and optional study, participant, status, or quality filters.



## OpenAPI

````yaml /api-reference/openapi.json get /api/public/v1/interviews/
openapi: 3.1.0
info:
  title: User Intuition Public API
  description: >-
    ## Public Integration API


    Programmatic access to User Intuition for external integrators: manage
    studies, participants, interviews, reports, and panels.


    ### Authentication


    All endpoints require a Bearer token — either an API key (prefixed `ui_sk_`,
    created in the dashboard) or a dashboard JWT:


    ```

    Authorization: Bearer <ui_sk_… or JWT>

    ```


    ### Base URLs


    - **Production:** `https://api.userintuition.ai`

    - **Staging:** `https://staging.userintuition.ai`


    ### Support


    For API support, contact support@userintuition.ai
  version: 1.0.0
  contact:
    name: User Intuition Support
    email: support@userintuition.ai
servers:
  - url: https://api.userintuition.ai
    description: Production
  - url: https://staging.userintuition.ai
    description: Staging
security:
  - BearerAuth: []
paths:
  /api/public/v1/interviews/:
    get:
      tags:
        - public-interviews
      summary: List Interviews
      description: >-
        List interview summaries with pagination and optional study,
        participant, status, or quality filters.
      operationId: listInterviews
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
            title: Page
          example: 1
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 20
            title: Page Size
          example: 20
        - name: study_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by study
            title: Study Id
          description: Filter by study
          example: 11111111-2222-3333-4444-555555555555
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by interview status
            title: Status
          description: Filter by interview status
          example: completed
        - name: quality
          in: query
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
            description: Filter by quality (Excellent, Good, Fair, Poor)
            title: Quality
          description: Filter by quality (Excellent, Good, Fair, Poor)
          example:
            - Good
            - Excellent
        - name: participant_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by participant ID
            title: Participant Id
          description: Filter by participant ID
        - name: X-UI-Organization-ID
          in: header
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 128
              - type: 'null'
            description: >-
              Platform admins only: choose an organization for scoped reads and
              writes. Required to change another organization's study or use its
              wallet.
            title: X-Ui-Organization-Id
          description: >-
            Platform admins only: choose an organization for scoped reads and
            writes. Required to change another organization's study or use its
            wallet.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicInterviewList'
        '422':
          description: Public API error. X-Request-ID matches error.request_id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
        default:
          description: Public API error. X-Request-ID matches error.request_id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
components:
  schemas:
    PublicInterviewList:
      properties:
        interviews:
          items:
            $ref: '#/components/schemas/PublicInterviewSummary'
          type: array
          title: Interviews
        total_count:
          type: integer
          title: Total Count
        page:
          anyOf:
            - type: integer
            - type: 'null'
          title: Page
        page_size:
          anyOf:
            - type: integer
            - type: 'null'
          title: Page Size
      type: object
      required:
        - interviews
        - total_count
      title: PublicInterviewList
    PublicApiErrorResponse:
      type: object
      required:
        - detail
        - error
      properties:
        detail:
          description: Legacy error detail; may be a string, list, or object.
        error:
          $ref: '#/components/schemas/PublicApiError'
    PublicInterviewSummary:
      properties:
        id:
          type: string
          title: Id
        study_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Study Id
          description: The study this interview belongs to
        participant:
          anyOf:
            - $ref: '#/components/schemas/PublicInterviewParticipant'
            - type: 'null'
          description: >-
            null for synthetic, anonymous panel, external-panel, or open-link
            interviews
        participant_source:
          type: string
          enum:
            - byop
            - panel
            - external_panel
            - link
            - synthetic
            - unknown
          title: Participant Source
          description: >-
            Recruitment source; synthetic, anonymous panel and open-link
            respondents have no public person identity
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
        quality:
          anyOf:
            - type: string
            - type: 'null'
          title: Quality
          description: 'Quality rating: Excellent, Good, Fair, or Poor'
        ended_because:
          anyOf:
            - type: string
              enum:
                - completed
                - participant_left
                - time_limit
                - technical_error
                - screened_out
            - type: 'null'
          title: Ended Because
          description: >-
            Why the interview ended; null if the stored reason cannot be
            classified
        started_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Started At
          description: Date and time the interview took place
        ended_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Ended At
          description: Date and time the interview ended
        interview_format:
          anyOf:
            - type: string
              enum:
                - chat
                - video
                - voice
            - type: 'null'
          title: Interview Format
          description: Stored interview mode; null when the historical mode is unknown
        language:
          anyOf:
            - type: string
            - type: 'null'
          title: Language
          description: >-
            Current configured study language, not a detected transcript
            language; historical interviews may have used an earlier
            configuration
        duration_seconds:
          anyOf:
            - type: integer
            - type: 'null'
          title: Duration Seconds
          description: Interview length in seconds (ended_at - started_at)
      type: object
      required:
        - id
        - participant_source
      title: PublicInterviewSummary
      description: |-
        Lightweight interview shape returned by the list endpoint (transcript,
        recordings, and analysis are stripped — fetch by id to get them).
    PublicApiError:
      type: object
      required:
        - code
        - message
        - field
        - request_id
        - outcome
        - recovery_action
        - docs_url
      properties:
        code:
          type: string
        message:
          type: string
        field:
          anyOf:
            - type: string
            - type: 'null'
        request_id:
          type: string
          format: uuid
        outcome:
          type: string
          enum:
            - not_started
            - failed
            - unknown
        recovery_action:
          type: string
        docs_url:
          type: string
          format: uri
    PublicInterviewParticipant:
      properties:
        id:
          anyOf:
            - type: string
            - type: 'null'
          title: Id
          description: BYOP invitation ID, not a deduplicated person ID
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
      type: object
      title: PublicInterviewParticipant
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authenticate with an API key (prefixed `ui_sk_`) or a JWT token from the
        dashboard.

````

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