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

# Get products

> Retrieve a single product by ID, or omit the ID to get all dashboard products.




## OpenAPI

````yaml /api-reference/rest-api.yaml get /products/{id}
openapi: 3.1.0
info:
  title: Qonversion REST API
  version: '3.1'
  description: >
    Qonversion REST API 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.


    ## Where to find your keys


    1. Sign in to the Qonversion dashboard at https://dash.qonversion.io/.

    2. Open your project and go to **Project Settings** in the sidebar.

    3. The **Project Keys** section exposes three values:
       - **Project Key** - bearer token for the v3 REST endpoints documented here.
         A 32-character URL-safe random string (`A-Z`, `a-z`, `0-9`, `_`, `-`) with no fixed prefix
         (e.g. `JFPATc4VaaWYsfurml3qZ4zsmNw0VfWH`).
       - **API Key** - used in the URL path of the analytics API
         (`https://api.qonversion.io/v1/analytics/{API_KEY}/...`); do NOT use it as a v3 bearer.
       - **Secret Key** - bearer for the entitlement grant/revoke endpoints. Always prefixed with `sk_`.

    ## Sandbox vs production


    Project Keys with the `test_` prefix (e.g.
    `test_PV77YHL7qnGvsdmpTs7gimsxUvY-Znl2`) target the

    **sandbox** environment. Production keys have no prefix. The same prefix
    scheme applies to Secret

    Keys. Sandbox users do not affect production analytics.


    ## Errors


    All endpoints share the error envelope shown in `Error`. The
    `meta.reference` URL is set

    automatically for the documented machine-readable codes (`invalid_data`,
    `invalid_request`,

    `invalid_entitlement_data`); other errors omit `meta`. There is no
    `meta.fields[]` array.
servers:
  - url: https://api.qonversion.io/v3
    description: Production
security:
  - ProjectKey: []
paths:
  /products/{id}:
    get:
      tags:
        - Products
      summary: Get products
      description: >
        Retrieve a single product by ID, or omit the ID to get all dashboard
        products.
      operationId: getProduct
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Qonversion product UID
          example: premium_monthly
      responses:
        '200':
          description: Product retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardProduct'
              examples:
                subscription:
                  summary: Monthly subscription
                  value:
                    uid: premium_monthly
                    project_id: 12345
                    type: 1
                    apple_product_id: com.app.premium_monthly
                    google_product_id: com.app.premium_monthly
                    stripe_product_id: prod_abc123
                    duration: 1
                    subscription_duration: P1M
                    created_at: 1665669916
                    updated_at: 1665669916
                one_time:
                  summary: One-time purchase
                  value:
                    uid: lifetime_access
                    project_id: 12345
                    type: 3
                    apple_product_id: com.app.lifetime
                    google_product_id: com.app.lifetime
                    created_at: 1665669916
                    updated_at: 1665669916
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Product not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ProjectKey: []
components:
  schemas:
    DashboardProduct:
      type: object
      properties:
        uid:
          type: string
          description: Unique identifier of the Qonversion product
          example: premium_monthly
        project_id:
          type: integer
          description: Numeric ID of the Qonversion project owning this product
          example: 12345
        type:
          type: integer
          enum:
            - 0
            - 1
            - 2
            - 3
          description: |
            Product type:
            - `0` = Subscription With Promo Period
            - `1` = Regular Subscription
            - `2` = Non-Recurring (Consumable)
            - `3` = Non-Consumable (Lifetime)
          example: 1
        apple_product_id:
          type: string
          description: Product identifier in App Store Connect
          example: com.app.premium_monthly
        google_product_id:
          type: string
          description: Product identifier in Google Play Console
          example: com.app.premium_monthly
        google_base_plan_id:
          type: string
          description: Base plan identifier in Google Play Console
          example: monthly-base
        stripe_product_id:
          type: string
          description: Product identifier in Stripe
          example: prod_abc123
        duration:
          type: integer
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
          description: >-
            Duration: `0` = Weekly, `1` = Monthly, `2` = Three Monthly, `3` =
            Six Monthly, `4` = Annual
          example: 1
        subscription_duration:
          type: string
          enum:
            - P1W
            - P1M
            - P3M
            - P6M
            - P1Y
          description: >
            ISO 8601 subscription duration string derived from `duration`.
            Server-computed:

            `P1W` for Weekly, `P1M` for Monthly, `P3M` for Three Monthly, `P6M`
            for Six Monthly,

            `P1Y` for Annual. Present only for subscription products (`type` 0
            or 1).
          example: P1M
        created_at:
          type: integer
          description: Creation timestamp (Unix seconds)
          example: 1665669916
        updated_at:
          type: integer
          description: Last-update timestamp (Unix seconds)
          example: 1665669916
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - type
          properties:
            type:
              type: string
              enum:
                - request
                - resource
                - logical
                - internal
              description: Error category
            code:
              type: string
              description: Machine-readable error code
            message:
              type: string
              description: Human-readable error message
        meta:
          type: object
          description: >
            Optional metadata. Currently only contains a `reference` URL for a
            small subset

            of error codes (`invalid_data`, `invalid_request`,
            `invalid_entitlement_data`).
          properties:
            reference:
              type: string
              format: uri
              example: >-
                https://documentation.qonversion.io/reference/handling-api-errors
  securitySchemes:
    ProjectKey:
      type: http
      scheme: bearer
      description: >
        Use your **Project Key** from the Qonversion dashboard

        (Project Settings -> Project Keys -> Project Key).


        Production keys have no prefix; keys prefixed with `test_` target the
        sandbox environment.


        Example (sandbox): `Bearer test_PV77YHL7qnGvsdmpTs7gimsxUvY-Znl2`

        Example (production): `Bearer JFPATc4VaaWYsfurml3qZ4zsmNw0VfWH`

````