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

# List experiments

> Returns all experiments for the authenticated project.



## OpenAPI

````yaml /api-reference/rest-api-v4.yaml get /experiments
openapi: 3.0.3
info:
  title: Qonversion REST API v4
  version: '4.0'
  description: >-
    Qonversion REST API v4 follows REST standards. It has predictable
    resource-oriented URLs, accepts JSON-encoded request bodies, returns
    JSON-encoded responses, and uses standard HTTP response codes,
    authentication, and verbs.
servers:
  - url: https://api.qonversion.io/v4
    description: Production
security:
  - secretAuth: []
tags:
  - name: Users
    description: Retrieve Qonversion users
  - name: User Properties
    description: Manage user-level attributes
  - name: Identities
    description: Link Qonversion users to your own auth IDs
  - name: Entitlements
    description: Entitlement definitions and user grants
  - name: Purchases
    description: A user's purchase history
  - name: Products
    description: Products configured in the Qonversion dashboard
  - name: Customers
    description: Aggregated customer records, properties, permissions, and metrics
  - name: Segments
    description: Dynamic and system segments of users
  - name: Experiments
    description: Paywall and offering A/B experiments
  - name: Screens
    description: No-code paywall screens — CRUD, publish, analytics
  - name: Analytics
    description: Charts, cards, cohorts, LTV, and insights
  - name: Exports
    description: Asynchronous data exports
  - name: Events
    description: Event catalog
  - name: Scheduled Reports
    description: Recurring reports delivered to external destinations
  - name: Integrations
    description: Third-party integrations configuration
  - name: Automations
    description: Event-driven automations
  - name: Project Settings
    description: Project-level configuration, secret, and store credentials
paths:
  /experiments:
    get:
      tags:
        - Experiments
      summary: List experiments
      description: Returns all experiments for the authenticated project.
      operationId: v4ListExperiments
      responses:
        '200':
          description: A list of experiments.
          headers:
            Cache-Control:
              schema:
                type: string
                example: no-cache
          content:
            application/json:
              schema:
                type: object
                required:
                  - object
                  - url
                  - data
                  - has_more
                properties:
                  object:
                    type: string
                    enum:
                      - list
                  url:
                    type: string
                    example: /v4/experiments
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/V4Experiment'
                  has_more:
                    type: boolean
                    example: false
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '502':
          description: Upstream service failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '504':
          description: Upstream timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
      security:
        - secretAuth: []
components:
  schemas:
    V4Experiment:
      type: object
      properties:
        object:
          type: string
          example: experiment
        id:
          type: string
          description: Experiment identifier (server-generated UID).
        url:
          type: string
          description: Canonical API path.
        name:
          type: string
          description: Experiment display name.
        alias_id:
          type: string
          description: |
            User-facing stable identifier (supplied on POST, immutable after).
            Added in the DEV-777 response audit; was missing from the public
            envelope despite being accepted on create.
          example: paywall_ab_test_v3
        description:
          type: string
          description: Experiment description.
        status:
          type: string
          x-extensible-enum:
            - draft
            - active
            - paused
            - finished
          description: Current experiment status.
        started_at:
          type: string
          format: date-time
          nullable: true
          description: ISO 8601 timestamp when the experiment was started.
        finished_at:
          type: string
          format: date-time
          nullable: true
          description: ISO 8601 timestamp when the experiment was finished.
        segment_percent:
          type: number
          nullable: true
          description: Percentage of users included in the experiment.
        primary_metric:
          type: string
          nullable: true
          x-extensible-enum:
            - free_trials
            - trial_to_paid
            - trial_cancellation
            - new_subscriptions
            - subscription_cancellation
            - sales
            - proceeds
            - refunds
            - users
            - user_to_trial
            - user_to_paid
          description: >-
            Primary success metric. Legacy experiments created before the
            underscore naming may return hyphenated variants (e.g.
            `user-to-trial`, `subscription-cancellation`); treat them as
            read-only and migrate to the underscore form before sending them
            back on PATCH.
        goal_value:
          type: number
          nullable: true
          description: Target value for the primary metric.
        goal_direction:
          type: string
          nullable: true
          x-extensible-enum:
            - increase
            - decrease
          description: Desired direction of change for the primary metric.
        context_key:
          type: string
          description: Context key for context-specific experiments.
        is_context_specific:
          type: boolean
          description: Whether this experiment is restricted to a specific context.
        created_at:
          type: string
          format: date-time
          description: ISO 8601 creation timestamp.
        updated_at:
          type: string
          format: date-time
          description: ISO 8601 last update timestamp.
    V4Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
          properties:
            type:
              type: string
              enum:
                - request
                - resource
                - logical
                - internal
            code:
              type: string
              description: |
                Machine-readable snake_case error code. Examples include
                `invalid_data`, `invalid_request`, `invalid_product_id`,
                `not_found`, `already_exists`, `offering_already_exists`,
                `product_not_in_project`, `cannot_set_main_directly`,
                `cannot_demote_main`, `cannot_patch_experiment_variant`,
                `cannot_delete_experiment_variant`, and
                `cannot_setmain_experiment_variant`. Resource-specific codes
                are documented on the corresponding reference page.
            message:
              type: string
              description: Human-readable description. May change; do not parse.
            details:
              type: array
              nullable: true
              description: Per-field validation errors, present on 400 validation failures.
              items:
                type: object
                properties:
                  field:
                    type: string
                  message:
                    type: string
  securitySchemes:
    secretAuth:
      type: http
      scheme: bearer
      bearerFormat: sk_…
      description: >-
        Bearer authentication using the project **Secret Key** (prefixed with
        `sk_`, or `test_sk_` for sandbox). All v4 public endpoints require the
        Secret Key — see [Authentication](/reference/v4/authentication). Never
        expose the Secret Key in client-side code.

````