Products | Venue Docs

Home

get

Authorizations

Path parameters

siteKeystringrequired

Query parameters

limitnumber | nullableoptional

pagenumber | nullableoptional

orderBystringoptional

dirstring · enumoptionalAvailable options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://app.venuecms.com/api/v2/{siteKey}/public/products' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "records": [
    {
      "siteId": "text",
      "slug": "text",
      "order": 1,
      "featured": true,
      "featuredExpiration": "text",
      "author": "text",
      "image": {
        "siteId": "text",
        "uploaded": true,
        "inline": true,
        "url": "text",
        "mimeType": "text",
        "size": 1,
        "metadata": {},
        "title": "text",
        "caption": "text",
        "credit": "text",
        "altText": "text"
      },
      "localizedContent": [
        {
          "siteId": "text",
          "locale": "text",
          "title": "text",
          "content": "text",
          "shortContent": "text",
          "extraContent": "text",
          "excerpt": "text",
          "metaTitle": "text",
          "metaDescription": "text",
          "keywords": "text",
          "contentJSON": {}
        }
      ],
      "artists": [
        {
          "profile": {
            "siteId": "text",
            "slug": "text",
            "image": {
              "siteId": "text",
              "uploaded": true,
              "inline": true,
              "url": "text",
              "mimeType": "text",
              "size": 1,
              "metadata": {},
              "title": "text",
              "caption": "text",
              "credit": "text",
              "altText": "text"
            },
            "localizedContent": [
              {
                "siteId": "text",
                "locale": "text",
                "title": "text",
                "content": "text",
                "shortContent": "text",
                "extraContent": "text",
                "excerpt": "text",
                "metaTitle": "text",
                "metaDescription": "text",
                "keywords": "text",
                "contentJSON": {}
              }
            ]
          }
        }
      ],
      "variants": [
        {
          "id": "text",
          "siteId": "text",
          "order": 1,
          "price": 1,
          "currency": "text",
          "quantity": 1,
          "externalLink": "text",
          "catalogID": "text",
          "publicationDate": "text",
          "productTypeId": "text",
          "productId": "text",
          "image": {
            "siteId": "text",
            "uploaded": true,
            "inline": true,
            "url": "text",
            "mimeType": "text",
            "size": 1,
            "metadata": {},
            "title": "text",
            "caption": "text",
            "credit": "text",
            "altText": "text"
          },
          "productType": {
            "id": "text",
            "type": "text"
          }
        }
      ]
    }
  ],
  "count": 1
}

Retrieve a list of Products

get