> 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 # GetCmpConfig # Package: cookieConsentPolicy # Namespace: CmpConfigService # Method link: https://dev.wix.com/docs/api-reference/business-management/cookie-consent-policy/cmp-config/get-cmp-config.md ## Permission Scopes: Read CMP Configurations: SCOPE.CMP_CONFIG.READ_ONLY ## Introduction Retrieves a CMP config. --- ## REST API ### Schema ``` Method: getCmpConfig Description: Retrieves a CMP config. URL: https://www.wixapis.com/v2/cmp-configs Method: GET Return type: GetCmpConfigResponse - name: cmpConfig | type: CmpConfig | description: Requested CMP config. - name: revision | type: string | description: Revision number, which increments by 1 each time the CMP config is updated. To prevent conflicting changes, the current revision must be passed when updating the CMP config. - name: createdDate | type: string | description: Date and time the CMP config was created. - name: updatedDate | type: string | description: Date and time the CMP config was last updated. - name: socialElementsBlocked | type: boolean | description: Whether elements are blocked until consent is given. ``` ### Examples ### Get CmpConfig ```curl curl -X GET \ 'https://www.wixapis.com/consent/cmp/v2/cmp-configs' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.cookieConsentPolicy.CmpConfigService.getCmpConfig() Description: Retrieves a CMP config. Return type: PROMISE - name: revision | type: string | description: Revision number, which increments by 1 each time the CMP config is updated. To prevent conflicting changes, the current revision must be passed when updating the CMP config. - name: _createdDate | type: Date | description: Date and time the CMP config was created. - name: _updatedDate | type: Date | description: Date and time the CMP config was last updated. - name: socialElementsBlocked | type: boolean | description: Whether elements are blocked until consent is given. ``` ### Examples ### getCmpConfig ```javascript import { cmp } from '@wix/consent-policy'; async function getCmpConfig() { const response = await cmp.getCmpConfig(); }; ``` ### getCmpConfig (with elevated permissions) ```javascript import { cmp } from '@wix/consent-policy'; import { auth } from '@wix/essentials'; async function myGetCmpConfigMethod() { const elevatedGetCmpConfig = auth.elevate(cmp.getCmpConfig); const response = await elevatedGetCmpConfig(); } ``` ### getCmpConfig (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 { cmp } from '@wix/consent-policy'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { cmp }, // Include the auth strategy and host as relevant }); async function getCmpConfig() { const response = await myWixClient.cmp.getCmpConfig(); }; ``` ---