Skip to main content

Get category

Get category

Path Parameters
id int32 REQUIRED

The id of the category to get.

Responses
200

The requested category.

Schema OPTIONAL
Resource object OPTIONAL

An existing category.

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.

Message string OPTIONAL

A status message for the action taken.

Details string[] OPTIONAL

Any validation messages for the data on the current action.

404

Not found.

Schema OPTIONAL
Message string OPTIONAL

A status message for the action taken.

Details string[] OPTIONAL

Any validation messages for the data on the current action.