VUZDevelopers

Get all products

GET
/products

Returns paginated list of products for the business

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Query Parameters

search?string

Search term

isInventoryItem?boolean

Filter by inventory items only

productType?string

Filter by product type

Value in

  • "product"
  • "service"
isActive?boolean

Filter by active status. Defaults to true (only active products)

Defaulttrue
sortBy?string

Sort field

Default"usageCount"

Value in

  • "name"
  • "unitPrice"
  • "usageCount"
  • "createdAt"
sortOrder?string

Sort direction

Default"DESC"

Value in

  • "ASC"
  • "DESC"
page?number

Page number

Default1
limit?number

Items per page

Default25

Response Body

application/json

curl -X GET "https://example.com/products"
{  "items": [    {      "id": "string",      "businessId": "string",      "name": "string",      "nameEn": "string",      "productType": "product",      "sku": "string",      "description": "string",      "unitPrice": 0,      "costPrice": 0,      "unit": "string",      "barcode": "string",      "supplierSku": "string",      "imageUrl": "string",      "isInventoryItem": true,      "isActive": true,      "defaultWarehouseId": "string",      "retailPrice": 0,      "wholesalePrice": 0,      "specialPrice": 0,      "usageCount": 0,      "lastUsedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": 0,  "page": 0,  "limit": 0}