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
Use filters to return specific fields. Request specific fields sparse fieldsets.
Returns a maximum of 100 categories per request, which can be paginated with cursor-based pagination.
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/v2022-10-17/reference/api-overview#sparse-fieldsets | |
filter | string | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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/v2022-10-17/reference/api-overview#pagination | |
sort | string | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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":"adipisicing pariatur eu incididunt id","attributes":{"external_id":"occaecat Ut ut velit","name":"dolore a","updated":"1946-01-24T03:06:55.784Z"},"links":{"self":"http://LgAalNGal.eihcuh.cIIIei"}},{"type":"catalog-category","id":"dolore non Duis","attributes":{"external_id":"eiusmod mollit","name":"anim labore voluptate reprehenderit elit","updated":"1989-10-26T17:25:38.327Z"},"links":{"self":"https://pJyueoOYu.njeYz0FP"}}],"links":{"self":"http://dmJfyerUpdzdeKowYMJC.oaleFT,FItqSfdL1VNThRQSm2MW6AsKvDavCYyo6Ky4hbidE+X+-RapqUj8","first":"http://suqTfeKmpond.cqprklYs7Srvl4IsdFloQg2a","last":"http://QYSmVywykjFiFIxlfiovNZhTRDflPt.mxknvapVRXtwKdHjZlke-3eb5wD1INlQEUxdwEHUom+P,RFPCR","prev":"https://QGsu.ugQA3WIdtIr,tZNeb4TjzZH","next":"http://jUOlMxLZZXyZmsADImtgaO.zbvijxC6EOV4TsYieVfP9mHDgPz9RDAlwSODjWnjLLT-0BVg"}}