> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# QueryCategories

# Package: services

# Namespace: CategoriesService

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/categories-v2/query-categories.md

## Permission Scopes:
Read Bookings - Public Data: SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC

## Introduction

Retrieves up to 1000 categories, given the specified paging, filtering, and sorting.

---

## REST API

### Schema

```
 Method: queryCategories
 Description: Retrieves up to 1000 categories, given the specified paging, filtering, and sorting.   ### Defaults  Query Categories has the following default settings, which you can override:  - Most responses are sorted by `id` in ascending order. __Tip__: Always specify a sort order to ensure consistent results. - `cursorPaging.limit` set to `50`.  ### See also  To learn about working with Query methods in general, see:  - [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md). - [Sorting](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging.md). - [Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging.md#paging).
 URL: https://www.wixapis.com/bookings/v2/categories/query
 Method: POST
 Method parameters:
   param name: query | type: CursorQuery   
     - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. 
        - name: limit | type: integer | description: Maximum number of items to return in the results. 
        - name: cursor | type: string | description: Pointer to the next or previous page in the list of results.  Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. 
        - name: filter | type: object | description: Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` 
        - name: sort | type: array<Sorting> | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` 
           - name: fieldName | type: string | description: Name of the field to sort by. 
           - name: order | type: SortOrder | description: Sort order. 
                 - enum: ASC, DESC
 Return type: QueryCategoriesResponse
  - name: categories | type: array<Category> | description: Retrieved categories. 
     - name: id | type: string | description: Category GUID. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the category is updated. To prevent conflicting changes, you must specify the current revision when updating the category.  Ignored when creating a category. 
     - name: createdDate | type: string | description: Date and time the category was created in `YYYY-MM-DDThh:mm:ss.sssZ` format. 
     - name: updatedDate | type: string | description: Date and time the Category was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format. 
     - name: name | type: string | description: Category name. 
     - name: sortOrder | type: integer | description: Defines the category's position in the categories list relative to other categories. Wix Bookings assigns `sortOrder` values with large gaps between adjacent categories, allowing efficient reordering without updating the entire list. When gaps become too small, the system automatically reassigns new `sortOrder` values to restore larger gaps. 
     - name: extendedFields | type: ExtendedFields | description: Custom field data for the category object.  [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. 
        - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). 
  - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata. 
     - name: count | type: integer | description: Number of items returned in the response. 
     - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. 
        - name: next | type: string | description: Cursor string pointing to the next page in the list of results. 
        - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. 
     - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page.  + `true`: Another page of results can be retrieved. + `false`: This is the last page. 


```

### Examples

### // @Retrieve all categories @description: Queries categories with cursor paging
import { categoriesV2 } from "@wix/bookings";

```curl
async function queryCategories() {
  const response = await categoriesV2.queryCategories({
    query: {
      cursorPaging: {
        cursor: null,
        limit: 100,
      },
    },
  });
  return response;
}
```

### // @Retrieve categories matching a filter @description: Queries categories with a name filter
import { categoriesV2 } from "@wix/bookings";

```curl
async function queryCategories() {
  const response = await categoriesV2.queryCategories({
    query: {
      cursorPaging: {
        cursor: null,
        limit: 100,
      },
      filter: {
        name: { $startsWith: "Our services" },
      },
    },
  });
  return response;
}
```

### Retrieve all categories
```curl
curl -X POST \
'https://www.wixapis.com/bookings/v2/categories/query' \
-H 'Authorization: <AUTH>' \
-d '{
  "query": {
    "cursorPaging": {
      "cursor": null,
      "limit": 100
    }
  }
}'
```

### Retrieve categories matching a filter
```curl
curl -X POST \
'https://www.wixapis.com/bookings/v2/categories/query' \
-H 'Authorization: <AUTH>' \
-d '{
  "query": {
    "cursorPaging": {
      "cursor": null,
      "limit": 100
    },
    "filter": {
      "name": {
        "$startsWith": "Our services"
      }
    }
  }
}'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.services.CategoriesService.queryCategories(query)
 Description: Retrieves up to 1000 categories, given the specified paging, filtering, and sorting.   ### Defaults  Query Categories has the following default settings, which you can override:  - Most responses are sorted by `id` in ascending order. __Tip__: Always specify a sort order to ensure consistent results. - `cursorPaging.limit` set to `50`.  ### See also  To learn about working with Query methods in general, see:  - [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md). - [Sorting](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging.md). - [Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging.md#paging).
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  query
 Method parameters: 
   param name: query | type: CategoryQuery   | required: true
     - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. 
        - name: limit | type: integer | description: Maximum number of items to return in the results. 
        - name: cursor | type: string | description: Pointer to the next or previous page in the list of results.  Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. 
        - name: filter | type: object | description: Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` 
        - name: sort | type: array<Sorting> | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` 
           - name: fieldName | type: string | description: Name of the field to sort by. 
           - name: order | type: SortOrder | description: Sort order. 
                 - enum: ASC, DESC
 Return type: PROMISE<QueryCategoriesResponse>
  - name: categories | type: array<Category> | description: Retrieved categories. 
     - name: _id | type: string | description: Category GUID. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the category is updated. To prevent conflicting changes, you must specify the current revision when updating the category.  Ignored when creating a category. 
     - name: _createdDate | type: Date | description: Date and time the category was created in `YYYY-MM-DDThh:mm:ss.sssZ` format. 
     - name: _updatedDate | type: Date | description: Date and time the Category was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format. 
     - name: name | type: string | description: Category name. 
     - name: sortOrder | type: integer | description: Defines the category's position in the categories list relative to other categories. Wix Bookings assigns `sortOrder` values with large gaps between adjacent categories, allowing efficient reordering without updating the entire list. When gaps become too small, the system automatically reassigns new `sortOrder` values to restore larger gaps. 
     - name: extendedFields | type: ExtendedFields | description: Custom field data for the category object.  [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. 
        - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). 
  - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata. 
     - name: count | type: integer | description: Number of items returned in the response. 
     - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. 
        - name: next | type: string | description: Cursor string pointing to the next page in the list of results. 
        - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. 
     - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page.  + `true`: Another page of results can be retrieved. + `false`: This is the last page. 


```

### Examples

### queryCategories
```javascript
import { categoriesV2 } from '@wix/bookings';

async function queryCategories(query) {
  const response = await categoriesV2.queryCategories(query);
};
```

### queryCategories (with elevated permissions)
```javascript
import { categoriesV2 } from '@wix/bookings';
import { auth } from '@wix/essentials';

async function myQueryCategoriesMethod(query) {
  const elevatedQueryCategories = auth.elevate(categoriesV2.queryCategories);
  const response = await elevatedQueryCategories(query);
}
```

### queryCategories (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { categoriesV2 } from '@wix/bookings';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { categoriesV2 },
  // Include the auth strategy and host as relevant
});


async function queryCategories(query) {
  const response = await myWixClient.categoriesV2.queryCategories(query);
};
```

---