HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference
These docs are for a deprecated API version. Click here to use the latest version.

Get Catalog Category Items

Get all items in a category with the given category ID.
Items can be sorted by the following fields, in ascending and descending order: created
Include parameters can be provided to get the following related resource data: variants
Returns a maximum of 100 items per request.

Rate limits:
Burst: 350/s
Steady: 3500/m

Scopes:
Catalogs Read

Path Params
string
required
Defaults to $custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL

The catalog category ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default.

Query Params
array of strings
fields[catalog-item]
array of strings
fields[catalog-variant]
string

For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering
Allowed field(s)/operator(s):
ids: any
category: equals
title: contains
published: equals

array of strings
include
Headers
string
required
Defaults to 2023-01-24

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

Language
Credentials