Category Object


Deprecated

This object is deprecated.

Properties
additionalCommentReactionsArray <Reaction>maxItems 5

Defines what additional reactions may be applied on the comment under the posts created in this category.


additionalPostReactionsArray <Reaction>maxItems 5

Defines what additional reactions may be applied on the posts created in this category.


categoryAccessstringRead-only

Whether all site visitors and members (PUBLIC), all members (MEMBERS_ONLY), or only specific members and groups of members with roles, badges or paid subscriptions (PRIVATE) can access posts in category.


commentInteractionstring

Defines what interactions may be applied on the comment under the posts created in this category, vote or like.


createdDatestringRead-onlyformat date-time

Date category was created.


descriptionstringmaxLength 140

Category description.


groupsArray <string>Read-only

IDs of groups which can access this category if categoryAccess is PRIVATE.


headerImageImage

Category header image.


headerTitlestringmaxLength 35

Category header title.


headerTypestring

Category header type.


idstringRead-only

Category ID.


mainCommentReactionReaction

Defines which icon will be used for the main reaction on the comment under the posts created in this category.

Default type: "LIKE".


mainPostReactionReaction

Defines which icon will be used for main reaction on the posts created in this category.

Default type: "LIKE".


namestringminLength 1maxLength 35

Category name.


noMemberPostingboolean

Whether only admins and moderators can write posts in category.


parentIdstring

Category parent ID.


postCountintegerRead-onlyformat int32

Total number of posts in category.


postInteractionstring

Defines what interactions may be applied on the posts created in this category, like or multiple reactions.


postTypesArray <string>deprecated

List of post type that Category supports. Deprecated on '2021-08-03'.


postViewCountintegerRead-onlyformat int32

Total number of post views in category.


rankintegerRead-onlyformat int32

Category rank (display order).


slugstringRead-only

Category slug.


updatedDatestringformat date-time

Date category was updated.


urlPageUrlRead-only

Category URL.

Did this help?