> 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: faqApp # Namespace: CategoryService # Method link: https://dev.wix.com/docs/api-reference/business-management/faq-app/category-v2/query-categories.md ## Permission Scopes: Read FAQ: SCOPE.DC-LABS.READ-FAQ ## Introduction Retrieves a list of categories, given the provided paging, filtering, and sorting. --- ## REST API ### Schema ``` Method: queryCategories Description: Retrieves a list of categories, given the provided paging, filtering, and sorting. URL: https://www.wixapis.com/faq/v2/categories/query Method: POST Method parameters: param name: query | type: CursorQuery - name: cursorPaging | type: CursorPaging | description: Cursor paging options. Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#cursor-paging). - 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. Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#the-filter-section). - name: sort | type: array | description: Sort object. Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#the-sort-section). - 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 | description: List of categories matching the query. - 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, the current revision must be specified when updating the category. Ignored when creating a category. - name: createdDate | type: string | description: Date and time the category was created. - name: updatedDate | type: string | description: Date and time the category was last updated. - name: title | type: string | description: Category title displayed on a site's Wix FAQ widgets. - name: sortOrder | type: number | description: Order of the category within a site's Wix FAQ dashboard page. Categories with lower sort order values appear first. - 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 for retrieving additional results. - name: count | type: integer | description: Number of items returned in current page. - 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 ```curl ~~~cURL curl --request POST \ --url https://www.wixapis.com/faq/v2/categories/query \ --header 'Authorization: ' \ --header 'Content-Type: application/json' \ --data '{ "query": { "filter": "{\"title\": {\"$contains\": \"shipping\"}}", "sort": [{"field_name": "sort_order", "order": "ASC"}], "paging": {"limit": 10} } }' ~~~ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.faqApp.CategoryService.queryCategories(query) Description: Retrieves a list of categories, given the provided paging, filtering, and sorting. # 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 paging options. Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#cursor-paging). - 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. Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#the-filter-section). - name: sort | type: array | description: Sort object. Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#the-sort-section). - 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 - name: categories | type: array | description: List of categories matching the query. - 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, the current revision must be specified when updating the category. Ignored when creating a category. - name: _createdDate | type: Date | description: Date and time the category was created. - name: _updatedDate | type: Date | description: Date and time the category was last updated. - name: title | type: string | description: Category title displayed on a site's Wix FAQ widgets. - name: sortOrder | type: number | description: Order of the category within a site's Wix FAQ dashboard page. Categories with lower sort order values appear first. - 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 for retrieving additional results. - name: count | type: integer | description: Number of items returned in current page. - 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 { category } from '@wix/faq'; async function queryCategories(query) { const response = await category.queryCategories(query); }; ``` ### queryCategories (with elevated permissions) ```javascript import { category } from '@wix/faq'; import { auth } from '@wix/essentials'; async function myQueryCategoriesMethod(query) { const elevatedQueryCategories = auth.elevate(category.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 { category } from '@wix/faq'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { category }, // Include the auth strategy and host as relevant }); async function queryCategories(query) { const response = await myWixClient.category.queryCategories(query); }; ``` ---