Categories: Supported Filters and Sorting

The following table shows field support for filters and sorting for the Category object:

Field	Supported Filters	Sortable
`id`	`$eq`, `$ne`, `$hasSome`
`title`	`$eq`, `$ne`, `$contains`, `$startsWith`, `$endsWith`, `$hasSome`,`$lt`, `$lte`, `$gt`, `$gte`, `$exists`, `$in`	Sortable
`label`	`$eq`, `$ne`, `$contains`, `$startsWith`, `$endsWith`, `$hasSome`,`$lt`, `$lte`, `$gt`, `$gte`, `$exists`, `$in`	Sortable
`postCount`	`$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`	Sortable
`displayPosition`	`$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`	Sortable
`translationId`	`$eq`, `$ne`, `$exists`, `$in`
`language`	`$eq`, `$ne`, `$exists`, `$in`	Sortable
`slug`	`$hasSome`, `$hasAll`	Sortable

Related content: API Query Language, Query endpoint 1

Was this helpful?

Yes

Category Object

Properties

idstringRead-onlyformat GUID

Category ID.

labelstringmaxLength 35

Category label. Displayed in the Category Menu.

postCountintegerRead-only

Number of posts in the category.

urlobject

Category URL.

descriptionstringmaxLength 500

Category description.

titlestringmaxLength 200

Category title.

coverMediaobject

Deprecated. Use coverImage instead. This property will be removed on June 30, 2023. Category cover image or video.

oldRankintegerRead-only

Reserved for internal use.

rankintegerdeprecated - use displayPosition insteadformat int32

Deprecated. Use displayPosition instead. This property will be removed on June 30, 2023. Category position in sequence.

displayPositionintegerminimum 0format int32

Category position in sequence. Categories with a lower display position are displayed first. Categories with a position of -1 appear at the end of the sequence. Default: -1

translationIdstringRead-onlyformat GUID

ID of the category's translations. All translations of a single category share the same translationId.

languagestring

Category language. Two-letter language code in ISO 639-1 alpha-2 format.

slugstringmaxLength 100

Category slug. For example, 'category-slug'.

internalIdstringRead-onlymaxLength 24

Reserved for internal use.

seoDataobject

SEO data.

coverImageobject

Category cover image.

Was this helpful?

Yes

GetList Categories

Retrieves a list of up to 100 categories per request.

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

paging.limit is 50.
paging.offset is 0.

List Categories is sorted by displayPosition in descending order. This cannot be overridden.

Permission Scopes

For app development, you must have one of the following permission scopes:

Learn more about permission scopes.

Endpoint

GET

https://www.wixapis.com/v3/categories

Was this helpful?

Yes

PostCreate Category

Creates a category.

Permission Scopes

For app development, you must have one of the following permission scopes:

Learn more about permission scopes.

Endpoint

POST

https://www.wixapis.com/v3/categories

Event TriggersThis method triggers the following events:

Category Created

Was this helpful?

Yes

PatchUpdate Category

Updates a category.

Permission Scopes

For app development, you must have one of the following permission scopes:

Learn more about permission scopes.

Endpoint

PATCH

https://www.wixapis.com/v3/categories/{category.id}

Event TriggersThis method triggers the following events:

Category Updated

Was this helpful?

Yes

GetGet Category

Gets a category with the provided ID.

Permission Scopes

For app development, you must have one of the following permission scopes:

Learn more about permission scopes.

Endpoint

GET

https://www.wixapis.com/v3/categories/{categoryId}

Was this helpful?

Yes

DeleteDelete Category

Deletes a category.

Permission Scopes

For app development, you must have one of the following permission scopes:

Learn more about permission scopes.

Endpoint

DELETE

https://www.wixapis.com/v3/categories/{categoryId}

Event TriggersThis method triggers the following events:

Category Deleted

Was this helpful?

Yes

GetGet Category By Slug

Gets a category with the provided slug.

Permission Scopes

For app development, you must have one of the following permission scopes:

Learn more about permission scopes.

Endpoint

GET

https://www.wixapis.com/v3/categories/slugs/{slug=**}

Was this helpful?

Yes

PostQuery Categories

Retrieves a list of up to 100 categories, given the provided paging, filtering, and sorting. Query Categories runs with these defaults, which you can override.

displayPosition is sorted in DESC order.
paging.limit is 50.
paging.offset is 0.

For field support for filters and sorting, see Field Support for Filtering and Sorting.

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

Permission Scopes

For app development, you must have one of the following permission scopes:

Learn more about permission scopes.

Endpoint

POST

https://www.wixapis.com/v3/categories/query

Was this helpful?

Yes

Category Created

Triggered when a category is created.

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.blog.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.

createdEventobject

Event information.

Was this helpful?

Yes

Category Updated

Triggered when a category is updated.

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.blog.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.

updatedEventobject

Event information.

Was this helpful?

Yes

Category Deleted

Triggered when a category is deleted.

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.blog.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.

Was this helpful?

Yes