Search.../
  1. REST
Generate a test token to explore our APIs

Category Object

Attributes

NAME
TYPE
DESCRIPTION
id
Read Only
string

Category ID.

parentId
string

Category parent ID.

name
string

Category name.

headerTitle
string

Category header title.

headerType
string

Supported values: NONE, COLOR, IMAGE.

Category header type.

headerImage
object

Category header image.

rank
Read Only
integer

Category rank (display order).

postCount
Read Only
integer

Total number of posts in category.

postViewCount
Read Only
integer

Total number of post views in category.

slug
Read Only
string

Category slug.

url
Read Only
object

Category URL.

description
string

Category description.

postTypes
Deprecated
Array<string>

Supported values: DISCUSSION, QUESTION.

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

createdDate
Read Only
string

Date category was created.

categoryAccess
Read Only
string

Supported values: UNKNOWN, PUBLIC, MEMBERS_ONLY, PRIVATE.

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.

updatedDate
string

Date category was updated.

noMemberPosting
boolean

Whether only admins and moderators can write posts in category.

groups
Read Only
Array<string>

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

commentInteraction
Read Only
string

Supported values: UNKNOWN, REACTION, VOTE.

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

Was this helpful?

Object

json

1{
2 "id" : "5cacd5fe04976c0015f35362",
3 "parentId" : "001005fe04976c0015f35362",
4 "name" : "Discussion corner",
5 "headerTitle" : "Discussion corner",
6 "description" : "Share stories, ideas, pictures and more!",
7 "headerType" : "IMAGE",
8 "headerImage" : {
9 "id" : "image.jpg",
10 "url" : "https://static.wixstatic.com/media/image.jpg",
11 "height" : 760,
12 "width" : 2100
13 },
14 "rank" : 0,
15 "postCount" : 2,
16 "postViewCount" : 17,
17 "slug" : "discussion-corner",
18 "noMemberPosting" : true,
19 "categoryAccess" : "PUBLIC",
20 "createdDate" : "2019-04-09T17:27:26.171Z",
21 "updatedDate" : "2019-04-09T17:27:26.171Z",
22 "postTypes" : [ "DISCUSSION", "QUESTION" ],
23 "commentInteraction" : "REACTION",
24 "url" : {
25 "base" : "https://wix.com",
26 "path" : "/forum/discussion-corner"
27 }
28}