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. If the category is at the root level, this field will be 0.

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.

SecondaryDescriptions object[] — OPTIONAL

The localized secondary descriptions of the category.

LanguageCode string — OPTIONAL
Content string — OPTIONAL

The localized content.

Meta object — OPTIONAL

Meta information for a category.

Descriptions object[] — OPTIONAL

The localized meta descriptions of the category.

LanguageCode string — OPTIONAL
Content string — OPTIONAL

The localized content.

Keywords object[] — OPTIONAL

The localized meta keywords of the category.

LanguageCode string — OPTIONAL
Content string — OPTIONAL

The localized content.

Titles object[] — OPTIONAL

The localized meta titles 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.