POST

Query Categories


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

Permissions
Manage Events - all permissions
Read Events - all read permissions
Manage Events
Manage Guest List
Read Events
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/events/v1/categories/query

Body Params
queryQueryRequired

Options to use when querying categories. See API Query Language for more details.


fieldsetArray <string>maxItems 1

Predefined sets of fields to return.

  • COUNTS: Returns assignedEventsCount.
Response Object
categoriesArray <Category>

List of categories.


metaDataMetaData

Metadata for the paginated results.

Query categories by name
Request
cURL
curl -X POST 'https://www.wixapis.com/events/v1/categories/query' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH TOKEN>' \ -d '{ { "query": { "filter": { "name": { "$eq": "food" } } } }
Response
JSON
{ "categories": [ { "id": "e9779de3-a085-4255-b3a6-9559990d4436", "name": "food", "states": ["MANUAL"], "createdDate": "2021-04-01T09:49:37.068Z" } ], "metaData": { "count": 2, "offset": 0, "total": 2 } }
Errors

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

Did this help?