Skip to main content

Query categories

Query categories

Request Body REQUIRED

The query to filter categories by.

CreatedAfter date-time

Limits query to categories created after the specified date.

CategoryIds int32[]

Limits query to only include the supplied category ids.

Responses
200

A collection of categories matching the supplied query.

Schema OPTIONAL
object[]
CategoryId int32 OPTIONAL

The id of the category.

ParentCategoryId int32 OPTIONAL

The id of the parent category for the category.

Names object[] OPTIONAL

The localizable names of the category.

LanguageCode string OPTIONAL
Content string OPTIONAL

The localized content.

Descriptions object[] OPTIONAL

The localized descriptions of the category.

LanguageCode string OPTIONAL
Content string OPTIONAL

The localized content.

GoogleCategoryPath string OPTIONAL

The Google Taxonomy category path for the category, if any.

Hidden boolean OPTIONAL

Indicates if the category should be hidden from menus, filters etc.

Active boolean OPTIONAL

True if the category is active for use.