Skip to main content

How to list products

Use GET /v1/products to page through the catalog and drive integrations, reports, and agent tools.

Prerequisites​

Basic list​

curl -s "https://api.catazenta.com/v1/products?page=1&page_size=20" \
  -H "Authorization: Bearer ${TOKEN}" \
  -H "X-Tenant-Id: ${TENANT}"

Typical response shape:

{
  "items": [
    {
      "id": "uuid",
      "code": "SKU-001",
      "status": "approved",
      "product_family_id": "uuid"
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 142
}

Pagination​

ParameterPurpose
pagePage number (1-based)
page_sizeItems per page (respect max in API)

When page * page_size >= total, you have the last page. See Pagination & errors.

Filtering (common patterns)​

Exact query parameter names are in the Product API. Typical filters:

NeedApproach
By familyproduct_family_id filter
By statusstatus=draft / approved
By codeSearch or code filter
Recent changesSort by updated_at if supported
curl -s "https://api.catazenta.com/v1/products?page=1&page_size=50&status=approved" \
  -H "Authorization: Bearer ${TOKEN}" \
  -H "X-Tenant-Id: ${TENANT}"

Some APIs support include or expand parameters for attributes, variants, or categories — check the OpenAPI spec for your tenant version.

For attribute values only, you may use product detail endpoints after listing IDs.

UI equivalent​

Merchandisers browse the same data under Products in the PIM — Products guide.

Next steps​