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?

GET

Get Category


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Returns a single category by ID.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Forums
Read Forums
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/forum/v1/categories/{categoryId}

Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

GET

Get Category By Slug


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Returns a single category by URL slug.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Forums
Read Forums
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/forum/v1/categories/slugs/{slug}

Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

POST

Query Categories


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of categories, given the provided paging, filtering, and sorting.

Query Categories runs with these defaults, which you can override:

  • paging.limit is 10
  • paging.offset is 0

For field support for filters and sorting, see Categories: Supported Filters and Sorting.

To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Forums
Read Forums
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/forum/v1/categories/query

Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

Category Created


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

A new category was created.

Permissions
Manage Forums
Read Forums
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.forum.category.


slugstring

Event name. Expected created.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


createdEventCreatedEvent

Event information.


Did this help?

Category Deleted


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

An existing category was removed.

Permissions
Manage Forums
Read Forums
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.forum.category.


slugstring

Event name. Expected deleted.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


deletedEventstruct

Event information.


Did this help?

Category Updated


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

An existing category was updated.

Permissions
Manage Forums
Read Forums
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.forum.category.


slugstring

Event name. Expected updated.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


updatedEventUpdatedEvent

Event information.


Did this help?