Skip to main content
GET
/
product-catalogs
List product catalogs
curl --request GET \
  --url https://apiv2.example.com/product-catalogs \
  --header 'X-Api-Key: <api-key>'
{
  "items": [
    {
      "productCatalogId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "name": "US Consumer Catalog",
      "extendsDefault": true,
      "description": "Product catalog for US consumer customers"
    }
  ],
  "pagination": {
    "nextCursor": "<string>"
  }
}

Authorizations

X-Api-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Query Parameters

filter
string

Filter by catalog name or ID prefix.

limit
integer
default:100

The maximum number of items to return.

Required range: 1 <= x <= 1000
cursor
string

Opaque pagination token from a previous response's nextCursor.

Response

A list of product catalogs.

items
object[]
required
pagination
object
required