List products (optional)

Backs product recommendations. Omit it if the widget never shows catalog cards.

GET /api/products

cURL

curl --request GET \
  --url 'https://api.example.com/api/products' \
  --header 'x-widget-token: YOUR_API_KEY'

200

{
  "products": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "Replacement tent pole set",
      "price": "49.00",
      "url": "https://example.com/webhooks/stateset",
      "image": "https://cdn.example.com/products/tent-2p.jpg"
    }
  ]
}

Backs product recommendations. Omit it if the widget never shows catalog cards.

Query parameters

limit · integer

Maximum products to return

Response

ProductList

products · object[]

Show products

id · string

title · string

price · string

url · string

image · string

Status codes

Code	Meaning
200	OK
400	Error
401	Error

cURL

curl --request GET \
  --url 'https://api.example.com/api/products' \
  --header 'x-widget-token: YOUR_API_KEY'

200

{
  "products": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "Replacement tent pole set",
      "price": "49.00",
      "url": "https://example.com/webhooks/stateset",
      "image": "https://cdn.example.com/products/tent-2p.jpg"
    }
  ]
}