> 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 # QueryConsentConfigs # Package: cookieConsentPolicy # Namespace: ConsentConfigsService # Method link: https://dev.wix.com/docs/api-reference/business-management/cookie-consent-policy/consent-configs/query-consent-configs.md ## Permission Scopes: Consent config: SCOPE.CONSENT_CONFIG.MANAGE ## Introduction Retrieves a list of up to 1,000 consent configs, given the provided paging, filtering, and sorting ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language.md) | [REST](https://dev.wix.com/api/rest/getting-started/api-query-language)). --- ## REST API ### Schema ``` Method: queryConsentConfigs Description: Retrieves a list of up to 1,000 consent configs, given the provided paging, filtering, and sorting ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language.md) | [REST](https://dev.wix.com/api/rest/getting-started/api-query-language)). URL: https://www.wixapis.com/bu/legal/v1/consent-configs/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 | 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: QueryConsentConfigsResponse - name: consentConfigs | type: array | description: Requested consent configs. - ONE-OF: - name: tagDetails | type: AppDetails | description: Details about the app that owns the embed. - name: appId | type: string | description: App GUID. - name: componentId | type: string | description: App component GUID. - name: version | type: string | description: App version. - name: cookieDetails | type: CookieDetails | description: Cookie details. Not supported yet. - name: name | type: string | description: Cookie name. - name: description | type: string | description: Cookie description. - name: id | type: string | description: Consent config GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the consent config is updated. To prevent conflicting changes, the current revision must be passed when updating the consent config. Ignored when creating a consent config. - name: createdDate | type: string | description: Date and time the consent config was created. - name: updatedDate | type: string | description: Date and time the consent config was last updated. - name: configType | type: ConfigType | description: Type of consent config. Currently only the `TAG_OVERRIDE` type is supported. - enum: - UNKNOWN_CONFIG: Unknown config type. - TAG_OVERRIDE: Overrides the app embed's category. - name: consentCategory | type: ConsentCategory | description: The consent config's categories for compliance with privacy regulations. - enum: - UNKNOWN_CATEGORY: - essential: Includes core functionality such as security, verification of identity and network management. These cookies can’t be disabled. - functional: Includes collecting data to remember choices users make to improve and give a more personalised experience. - analytics: Includes tracking visitor interactions with a site, to discover errors and provide better overall analytics. - advertising: Includes tracking advertising effectiveness to provide a more relevant service and deliver better ads to suit visitors' interests. - data_to_third_party: Includes collecting data to pass on to a third party. - name: createdBy | type: CreatedBy | description: Consent config creator. - name: userId | type: string | description: User GUID. - name: appId | type: string | description: App GUID. - name: extendedFields | type: ExtendedFields | description: Custom field data for the consent config. Extended fields 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: tags | type: Tags | description: Consent config tags, meaning labels for administrative purposes. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - 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 ### Query ConsentConfig Query consent configs on site ```curl curl -X POST \ 'https://www.wixapis.com/consent/consent-config/v1/consent-configs' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ --data-binary '{ "query": {} }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.cookieConsentPolicy.ConsentConfigsService.queryConsentConfigs(query) Description: Retrieves a list of up to 1,000 consent configs, given the provided paging, filtering, and sorting ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language.md) | [REST](https://dev.wix.com/api/rest/getting-started/api-query-language)). # 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: ConsentConfigQuery | 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 | 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 - name: consentConfigs | type: array | description: Requested consent configs. - ONE-OF: - name: tagDetails | type: AppDetails | description: Details about the app that owns the embed. - name: appId | type: string | description: App GUID. - name: componentId | type: string | description: App component GUID. - name: version | type: string | description: App version. - name: cookieDetails | type: CookieDetails | description: Cookie details. Not supported yet. - name: name | type: string | description: Cookie name. - name: description | type: string | description: Cookie description. - name: _id | type: string | description: Consent config GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the consent config is updated. To prevent conflicting changes, the current revision must be passed when updating the consent config. Ignored when creating a consent config. - name: _createdDate | type: Date | description: Date and time the consent config was created. - name: _updatedDate | type: Date | description: Date and time the consent config was last updated. - name: configType | type: ConfigType | description: Type of consent config. Currently only the `TAG_OVERRIDE` type is supported. - enum: - UNKNOWN_CONFIG: Unknown config type. - TAG_OVERRIDE: Overrides the app embed's category. - name: consentCategory | type: ConsentCategory | description: The consent config's categories for compliance with privacy regulations. - enum: - UNKNOWN_CATEGORY: - essential: Includes core functionality such as security, verification of identity and network management. These cookies can’t be disabled. - functional: Includes collecting data to remember choices users make to improve and give a more personalised experience. - analytics: Includes tracking visitor interactions with a site, to discover errors and provide better overall analytics. - advertising: Includes tracking advertising effectiveness to provide a more relevant service and deliver better ads to suit visitors' interests. - data_to_third_party: Includes collecting data to pass on to a third party. - name: createdBy | type: CreatedBy | description: Consent config creator. - name: userId | type: string | description: User GUID. - name: appId | type: string | description: App GUID. - name: extendedFields | type: ExtendedFields | description: Custom field data for the consent config. Extended fields 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: tags | type: Tags | description: Consent config tags, meaning labels for administrative purposes. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - 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 ### queryConsentConfigs ```javascript import { consentConfig } from '@wix/consent-policy'; async function queryConsentConfigs(query) { const response = await consentConfig.queryConsentConfigs(query); }; ``` ### queryConsentConfigs (with elevated permissions) ```javascript import { consentConfig } from '@wix/consent-policy'; import { auth } from '@wix/essentials'; async function myQueryConsentConfigsMethod(query) { const elevatedQueryConsentConfigs = auth.elevate(consentConfig.queryConsentConfigs); const response = await elevatedQueryConsentConfigs(query); } ``` ### queryConsentConfigs (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 { consentConfig } from '@wix/consent-policy'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { consentConfig }, // Include the auth strategy and host as relevant }); async function queryConsentConfigs(query) { const response = await myWixClient.consentConfig.queryConsentConfigs(query); }; ``` ---