Skip to content
Website BuddyWebsite BuddyWebsite builder
Sign inGet started
API reference/Store

List a site's products

Try it

The site's store products in their shop order, each with its options, prices (cents) and stock. Hidden products are included unless you ask for active=true.

GET/api/v1/sites/{site_id}/products

Authentication

An API key as Authorization: Bearer or x-api-key. It needs the store:read scope — read store products, stock and orders.

store:readRead onlyMCP tool: list_products

Parameters

Named placeholders go in the path; the rest in the query string.

site_idstringPath · required
The site's id.1 to 100 characters
activestringQuery · optional
true = only products shown on the site; false = only hidden ones.One of: 0, 1, true, false

Response

200 with JSON on success (schema on the right). Errors use the standard envelope.

curl
curl -X GET 'https://websites.workflowcorp.com/api/v1/sites/SITE_ID/products?active=true' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY"
Example arguments
{
  "site_id": "SITE_ID",
  "active": "true"
}
Response schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "price_cents": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "image_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "weight_grams": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              {
                "type": "null"
              }
            ],
            "description": "Shipping weight of one, in grams (for by-weight shipping); null = not weighed."
          },
          "kind": {
            "type": "string",
            "enum": [
              "physical",
              "gift_card",
              "download"
            ],
            "description": "physical = picked up or shipped; gift_card = a code emailed after payment, spent at checkout; download = a file emailed as a one-use link after payment."
          },
          "download": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "bytes": {
                    "type": "integer",
                    "minimum": -9007199254740991,
                    "maximum": 9007199254740991
                  }
                },
                "required": [
                  "name",
                  "bytes"
                ],
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ],
            "description": "A download's file (upload it with upload_product_download); null for other kinds or before a file is added."
          },
          "active": {
            "type": "boolean",
            "description": "Shown on the site."
          },
          "address": {
            "type": "string",
            "description": "The product's page on the site's free address."
          },
          "options": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string",
                  "description": "\"\" for a product with a single, unnamed option."
                },
                "price_cents": {
                  "anyOf": [
                    {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991
                    },
                    {
                      "type": "null"
                    }
                  ],
                  "description": "null = the product's price."
                },
                "stock": {
                  "anyOf": [
                    {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991
                    },
                    {
                      "type": "null"
                    }
                  ],
                  "description": "How many are left; null = not counted (always available)."
                }
              },
              "required": [
                "id",
                "name",
                "price_cents",
                "stock"
              ],
              "additionalProperties": false
            }
          },
          "in_stock": {
            "type": "boolean",
            "description": "At least one option can be bought."
          },
          "is_sample": {
            "type": "boolean"
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "slug",
          "description",
          "price_cents",
          "image_url",
          "weight_grams",
          "kind",
          "download",
          "active",
          "address",
          "options",
          "in_stock",
          "is_sample",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false
}