Get Catalog Categories
GET {{baseUrl}}/api/catalog-categories/
Get all catalog categories in an account.
Catalog categories can be sorted by the following fields, in ascending and descending order: created
Returns a maximum of 100 categories per request.
Rate limits:
Burst: 350/s
Steady: 3500/m
Scopes:
Catalogs Read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields[catalog-category] | string | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | |
filter | string | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>ids: any<br>item: equals<br>name: contains | |
page[cursor] | string | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | |
sort | string | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Accept | string |
RESPONSES
status: OK
{"data":[{"type":"catalog-category","id":"qui","attributes":{"external_id":"sunt nostrud amet Duis","name":"fugiat","updated":"2022-11-08T00:00:00"},"links":{"self":"http://FHhEbBPQRgIztaEqYZmQqZYV.gvdjyW9jV89c0xYL9bNSomF"}},{"type":"catalog-category","id":"sunt irure sint","attributes":{"external_id":"est ea cillum","name":"fugiat officia cupidatat D","updated":"2022-11-08T00:00:00"},"links":{"self":"https://jtteUSHsEYSyZJGjfMap.quUDPdbBqOrkymOKzSnikN+5BSY"}}],"links":{"self":"https://XKRQOedxJYzKLSkDDnbWbzJViFUaDb.abCQQwPFJscMk1flkGkGTj+,FKtDeJj94ouEhOPLBUjYG2VD","first":"https://P.uvogK6","last":"https://nEeCOXjpQlhSlkpOVFEBPn.wsgua","prev":"https://DJzRAIaVWxkIBtTZjmYfRpRJ.ayLwC,ptHWFH91a","next":"http://snaOO.qegeyXj2nVfhpWyAlhnM,6Xnjtznnoh76fA.UgkC4Xd8T9YzPJ-xpyBqPARYOZ4qz09"}}