List Catalog Rules
Lists every catalog rule in the store — the data behind the admin Marketing → Promotions → Catalog Rules datagrid.
TIP
New here? Read the Catalog Rules overview for what a catalog rule does and how its fields behave.
Endpoint
| Endpoint | Method |
|---|---|
/api/admin/marketing/catalog-rules | GET |
Response envelope
Admin collections return a { data, meta } body envelope:
data— the catalog-rule rows for this page.meta—currentPage,perPage,lastPage,total,from,to.
Each row carries the flat rule fields shown in the example. The heavier conditions, channels, and customerGroups are served only by the detail endpoint — they are null on list rows.
Query parameters
| Parameter | Description |
|---|---|
page, per_page | Pagination (per_page default 10, max 50) |
id | Single id or comma-separated list (e.g. 1,4,9) |
name | Name — partial match |
status | 0 (inactive) / 1 (active) |
sort_order | Priority — exact match |
starts_from_from, starts_from_to | Start-date range (ISO 8601) |
ends_till_from, ends_till_to | End-date range (ISO 8601) |
sort, order | Sort field (id, name, sort_order) + asc / desc (default id desc) |
Filters compose with logical AND — more filters narrow the result.
Every /api/admin/* request requires an admin Bearer token.