Skip to main content
GET
List products in the Offerings catalogue.

Authorizations

x-api-key
string
header
required

Your workspace API key. It both authenticates the caller and selects the workspace.

Query Parameters

q
string

Keyword matched against product name and SKU.

active
boolean

Filter by active flag (true/false).

low_stock
boolean

When true, only products that track stock and are at/below their low-stock threshold.

category
string

Service-category uuid to filter by.

per_page
integer

Items per page (alias: limit), default 25, max 100.

Response

A paginated list.

A paginated collection. per_page defaults to 25 and is capped at 100.

data
object[]
meta
object