List products
Products
List products
List voucher product designs configured in your tenant.
GET
List products
Required scope:
Page shape (deprecated):
products:read
Rate limit: 300 requests/minute
A “product” is a voucher design / SKU configured in the VoucherGrid Design
Centre – for example, a $50 Birthday voucher or a Custom Amount voucher.
Pagination
Supports both cursor pagination (recommended) and page pagination (deprecated). The cursor shape wins if both are supplied. Cursor mode forcesORDER BY created_at DESC, id DESC and ignores the legacy sort_order
column on the underlying table.
Query parameters
Cursor shape (recommended)
| Parameter | Type | Default | Notes |
|---|---|---|---|
cursor | string | – | Opaque cursor from a previous response’s next_cursor |
limit | integer | 20 | 1–100 |
Page shape (deprecated)
| Parameter | Type | Default | Notes |
|---|---|---|---|
page | integer | 1 | 1-indexed |
per_page | integer | 20 | 1–100 |
Filters (both shapes)
| Parameter | Type | Default | Notes |
|---|---|---|---|
status | string | – | One of ready, internal, live, archived. internal products are staff-only – they appear in the in-app sale drawer but never on a public storefront. |
Response
Cursor shape:pricing_type is one of:
fixed– single set price (shown as Face Value in the Design Centre), infixed_amount.range– price betweenmin_amountandmax_amount.custom– price entered by the buyer (no preset bounds).
Errors
400– Invalidstatusvalue, or invalid/forged/cross-tenantcursor.