Category Object


Properties
idstringRead-only

Category ID.


parentIdstring

Category parent ID.


namestringminLength 1maxLength 35

Category name.


headerTitlestringmaxLength 35

Category header title.


headerTypestring

Category header type.


headerImageHeaderImage

Category header image.


rankintegerRead-onlyformat int32

Category rank (display order).


postCountintegerRead-onlyformat int32

Total number of posts in category.


postViewCountintegerRead-onlyformat int32

Total number of post views in category.


slugstringRead-only

Category slug.


urlUrlRead-only

Category URL.


descriptionstringmaxLength 140

Category description.


postTypesArray <string>deprecated

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


createdDatestringRead-onlyformat date-time

Date category was created.


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.


updatedDatestringformat date-time

Date category was updated.


noMemberPostingboolean

Whether only admins and moderators can write posts in category.


groupsArray <string>Read-only

Ids of groups which can access category if categoryAccess is PRIVATE.


commentInteractionstring

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


mainCommentReactionMainCommentReaction

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

Default type: "LIKE".


additionalCommentReactionsArray <Reaction>maxItems 5

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


postInteractionstring

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


mainPostReactionMainPostReaction

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

Default type: "LIKE".


additionalPostReactionsArray <Reaction>maxItems 5

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

Did this help?