---
title: "GET /products"
method: GET
path: "/products"
tags: ["Products"]
---

# GET /products

`GET /products`

## Query parameters

- `limit` integer
- `offset` integer
- `events.created.at` string, date-time
- `events.published.at` string, date-time
- `events.published.by.id` string
- `events.published.by.name` string
- `events.updated.at` string, date-time
- `events.updated.by.id` string
- `events.updated.by.name` string
- `external_id` string
- `groups.id` string
- `id` string
- `name` string
- `owner.id` string
- `owner.name` string
- `purchase_model` 'transactable' | 'referral'
- `replacement.id` string
- `sourcing.marketplaces` string
- `status` 'draft' | 'indevelopment' | 'oncertification' | 'published' | 'initializationfailed' | 'deleted' | 'endofsale'
- `visibility.catalog` string
- `visibility.listing` string
- `visibility.owner` string
- `visibility.syndication` string
- `category.id` string
- `category.parent` string

## Response `200`

- DpProductVersion[]
  - `id` string
  - `name` string
  - `external_id` string, required
  - `icon` string, binary
  - `status` string
  - `replacement` DpReplacementProduct
    - `id` string — Product ID
    - `icon` string, binary
    - `name` string
    - `status` string
  - `end_of_sale_notes` string
  - `short_description` string
  - `detailed_description` string
  - `configurations` object
    - `suspend_resume_supported` boolean
    - `requires_reseller_information` boolean
  - `customer_ui_settings` DpApplicationUI
    - `description` string
    - `getting_started` string
    - `download_links` DpDownloadLink[]
      - `title` string, required
      - `url` string, uri, required
      - `visible_for` 'admin' | 'user'
    - `documents` DpDocument[]
      - `title` string, required
      - `url` string, uri, required
    - `terms` DpTerm[]
      - `title` string, required
      - `url` string, uri, required
    - `languages` DpUILocale[]
      - `id` string, required
      - `name` string
    - `provisioning_message` string
  - `version` integer
  - `published_at` string, date-time, nullable
  - `category` DpCategoryReference
    - `id` string
    - `name` string, required
  - `owner` DpAccountReference
    - `id` string, required
    - `name` string
    - `icon` string, nullable
  - `latest` boolean
  - `media` object
    - `id` string
    - `type` string
    - `thumbnail` string
    - `url` string
  - `usage_rule` object
    - `enabled` boolean
    - `providers` object[]
      - `id` string
      - `name` string
  - `stats` object
    - `versions` integer
  - `capabilities` DpVirtualCapabilities
    - `ppu` DpPayAsYouGo
      - `ppu` boolean, required
      - `schema` 'TR' | 'CR' | 'PR' | 'QT'
      - `dynamic` boolean
      - `predictive` boolean
      - `future` boolean
      - `late` boolean
      - `required_custom_fields` string[]
    - `reservation` DpReservation
      - `consumption` boolean
    - `cart` DpCart
      - `validation` boolean
    - `inquiring` DpInquiring
      - `validation` boolean
    - `tiers` DpTiers
      - `updates` boolean
      - `configs` DpTiersConfigs
        - `configs` boolean, required
        - `level` string
        - `setup` DpTiersConfigsSetup
          - `inquiring_validation` boolean
        - `update` DpTiersConfigsUpdate
          - `validation` boolean
          - `inquiring_validation` boolean
      - `validation` boolean
    - `subscription` DpVCSubscriptionSerializer
      - `cancel` DpSubscriptionCancel
        - `editable_ordering_parameters` boolean
        - `scheduling` boolean
        - `offline` 'no' | 'auto' | 'allowed'
      - `change` DpSubscriptionChange
        - `editable_ordering_parameters` boolean
        - `validation` boolean
        - `inquiring_validation` boolean
        - `scheduling` boolean
        - `simultaneous_adjustment` boolean
        - `editable_fulfillment_parameters` boolean
      - `parameter` DpSubscriptionParameter
        - `versions` boolean
      - `purchase` DpSubscriptionPurchase
        - `scheduling` boolean
      - `resume` DpSubscriptionResume
        - `scheduling` boolean
      - `suspend` DpSubscriptionSuspend
        - `scheduling` boolean
        - `offline` 'no' | 'auto' | 'allowed'
      - `renew` DpSubscriptionRenew
        - `enable_renew` boolean
        - `editable_ordering_parameters` boolean
        - `editable_fulfillment_parameters` boolean
        - `validation` boolean
        - `inquiring_validation` boolean
        - `scheduling` boolean
        - `allow_items` boolean
      - `transfer` DpSubscriptionTransfer
        - `enable_transfer` boolean
        - `transfer_autoapprove` boolean
        - `editable_ordering_parameters` boolean
        - `editable_fulfillment_parameters` boolean
        - `validation` boolean
        - `inquiring_validation` boolean
      - `hold` boolean
      - `schema` 'explicit' | 'evergreen'
  - `visibility` object
    - `owner` boolean
    - `listing` boolean
    - `syndication` boolean
    - `catalog` boolean
  - `changes_description` string — Change log for product version
  - `public` boolean — Is version available for Providers
  - `staging` boolean — Is version available for staging tests
  - `events` object
    - `created` object
      - `at` string, datetime
      - `by` object
        - `id` string
        - `name` string
        - `icon` string
    - `published` object
      - `at` string, datetime
      - `by` object
        - `id` string
        - `name` string
        - `icon` string
    - `updated` object
      - `at` string, datetime
      - `by` object
        - `id` string
        - `name` string
        - `icon` string
  - `extensions` object
    - `id` string
    - `name` string
    - `status` string
    - `package_url` string
  - `purchase_model` string, required
  - `preferred_names` string

---

[API](https://skmtc.net/cloudblue/apis/cloudblue-connect-api.md) · [All operations](https://skmtc.net/cloudblue/apis/cloudblue-connect-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudblue/cloudblue-connect-api/revisions/0421d2a97c52/schema)