Category Object


Properties
idstringRead-only

Category ID.


parentIdstring

Category parent ID.


namestringminLength 1maxLength 35

Category name.


headerTitlestringmaxLength 35

Category header title.


headerTypestring
3 enum supported values:
NONECOLORIMAGE

Category header type.


headerImageobject

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.


urlobjectRead-only

Category URL.


descriptionstringmaxLength 140

Category description.


postTypesArray <string>deprecated
2 enum supported values:
DISCUSSIONQUESTION

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


createdDatestringRead-onlyformat date-time

Date category was created.


categoryAccessstringRead-only
4 enum supported values:
UNKNOWNPUBLICMEMBERS_ONLYPRIVATE

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
4 enum supported values:
UNKNOWNREACTIONVOTENONE

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


mainCommentReactionobject

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
3 enum supported values:
UNKNOWNREACTIONNONE

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


mainPostReactionobject

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.

Was this helpful?
Yes
No