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



## OpenAPI

````yaml /api-reference/openapi.json get /api/public/v1/studies/
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/studies/:
    get:
      tags:
        - public-studies
      summary: List Studies
      operationId: listStudies
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
            title: Page
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 1000
            minimum: 1
            default: 100
            title: Page Size
        - name: name
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by name
            title: Name
          description: Filter by name
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicStudyList'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PublicStudyList:
      properties:
        studies:
          items:
            $ref: '#/components/schemas/PublicStudySummary'
          type: array
          title: Studies
        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:
        - studies
        - total_count
      title: PublicStudyList
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PublicStudySummary:
      properties:
        id:
          type: string
          title: Id
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        study_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Study Type
          description: Study-type template slug
        recruiting_method:
          anyOf:
            - type: string
            - type: 'null'
          title: Recruiting Method
          description: panel or byop
        interview_format:
          anyOf:
            - type: string
              enum:
                - chat
                - video
                - voice
            - type: 'null'
          title: Interview Format
          description: chat, video, or voice
        voice:
          anyOf:
            - type: string
              enum:
                - male
                - female
            - type: 'null'
          title: Voice
          description: male or female
        language:
          anyOf:
            - type: string
            - type: 'null'
          title: Language
          description: Interview language code, e.g. 'en'
        byop_config:
          $ref: '#/components/schemas/PublicByopConfigOut'
        study_link:
          anyOf:
            - type: string
            - type: 'null'
          title: Study Link
          description: Universal interview link for the study
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
      type: object
      required:
        - id
      title: PublicStudySummary
      description: |-
        Lightweight study shape returned by the list endpoint (heavy fields such
        as the study plan and screener questions are stripped — fetch by id).
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    PublicByopConfigOut:
      properties:
        incentive_amount:
          anyOf:
            - type: number
            - type: 'null'
          title: Incentive Amount
        is_incentives_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Incentives Enabled
        auto_send_incentives:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Auto Send Incentives
      type: object
      title: PublicByopConfigOut
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Authenticate with an API key (prefixed `ui_sk_`) or a JWT token from the
        dashboard.

````