---
title: "Retrieve a notice configuration"
method: GET
path: "/widgets/notices/configs/{id}"
tags: ["notices"]
---

# Retrieve a notice configuration

`GET /widgets/notices/configs/{id}`

Returns a single notice configuration

## Path parameters

- `id` string, required

## Headers

- `v` '1' | '2'

## Response `200`

A NoticeConfig object

- NoticesConfig — Configuration (purposes and vendors, theme, format, etc.) of a consent notice
  - `id` string, required — The ID of the configuration
  - `organization_id` string, required — The ID of the organization that owns this configuration
  - `notice_id` string, required — The ID of the notice that this configuration belongs to
  - `platform` string — Platform (web, amp, mobile, or television) that this notice is running on
  - `default` boolean — Whether the notice should be used when no other notice is available and matching the target. If `default` is set to true, `targets` must be empty.
  - `targets` string[]
  - `custom_json` object — Custom JSON that will be merged into the final SDK configuration for GDPR
  - `config` object — Configuration of the notice
  - `full_atp` boolean — Whether the notice uses the ATP vendors selected by Didomi (false) or if it uses the client's ATP vendor selection (true)
  - `text_mode` string — Whether the notice is using a custom or an approved text. Possible values: approved, custom.
  - `text_id` string — ID of an approved notice text if this notice is configured for using an approved text in "text_mode"
  - `template_id` string — The ID of the notice template associated with this notice. "null" if this notice does not use configuration from a template.
  - `enable_ignore_consent_before` boolean — Whether the consent must be recollected after a certain date.
  - `ignore_consent_before` string — The date after which consent must be recollected if "enable_ignore_consent_before" is set to true.
  - `negative_action` 'button' | 'link' — What negative action should be displayed in the notice: Disagree to all ("button"), Continue without agreeing ("link") or no negative action (null)
  - `negative_action_link` boolean — Whether negative action should be a link or not.
  - `negative_action_link_format` 'text' | 'cross' — What format of negative action link should be displayed in the notice: Link with te text Continue without agreeing or link with the X icon.
  - `negative_action_button` boolean — Whether negative action should be a button or not.
  - `disagree_button_style` 'primary' | 'secondary' — The style of the Disagree button
  - `country` string — The country that the consent notice belongs to (two letter ISO code)
  - `notice_deny_applies_to_li` boolean — Do not keep legitimate interest enabled when the user disagrees in the notice
  - `preferences_deny_applies_to_li` boolean — Do not keep legitimate interest enabled when the user clicks on "Disagree to all" in the Preferences
  - `consent_duration` number — The duration that applies to collected consent. Consent is recollected after the expiration of the duration
  - `consent_duration_unit` 'months' | 'days' | 'seconds' — The unit of the consent duration
  - `denied_consent_duration` number — The duration that applies to fully negative consent. Consent is recollected after the expiration of the duration
  - `denied_consent_duration_unit` 'months' | 'days' | 'seconds' — The unit of the denied consent duration
  - `denied_consent_duration_custom` boolean — Whether the duration for denied consent is different from the generic
  - `cross_device_enabled` boolean — Whether the cross device feature is enabled
  - `cross_device_timeout` number — The timeout that applies to sync with consent notice
  - `gcm_enabled` boolean — Whether Google consent mode is enabled
  - `gcm_tcf_enabled` boolean — Whether the Google consent mode TCF integration is enabled
  - `gcm_set_default_status` boolean — Whether to set the default status for analytics and ads
  - `gcm_data_layer_name` string — Data layer name for Google consent mode
  - `gcm_analytics_default_status` boolean — Default status for analytics in Google Consent Mode
  - `gcm_ads_default_status` boolean — Default status for ads in Google Consent Mode
  - `gcm_functionality_default_status` boolean — Default status for functionality of the website e.g. language settings in Google Consent Mode
  - `gcm_personalization_default_status` boolean — Default status for personalization in Google Consent Mode
  - `gcm_security_default_status` boolean — Default status for security in Google Consent Mode
  - `gcm_ad_user_data_default_status` boolean — Default status for ad user data in Google Consent Mode
  - `gcm_ad_personalization_default_status` boolean — Default status for ad personalization in Google Consent Mode
  - `microsoft_enabled` boolean — Whether Microsoft consent mode is enabled
  - `microsoft_set_default_status` boolean — Whether to set the default status for ad storage in Microsoft Consent Mode
  - `microsoft_ad_storage_default_status` boolean — Default status for ad storage in Microsoft Consent Mode
  - `microsoft_enable_tcf_advertiser_consent_mode` boolean — Whether to enable TCF advertiser consent mode in Microsoft Consent Mode
  - `amazon_enabled` boolean — Whether Amazon consent mode is enabled
  - `amazon_set_default_status` boolean — Whether to set the default status for ads/user data in Amazon Consent Mode
  - `amazon_ad_storage_default_status` boolean — Default status for ad storage in Amazon Consent Mode
  - `amazon_ad_user_data_default_status` boolean — Default status for ad user data in Amazon Consent Mode
  - `wordpress_enabled` boolean — Whether WordPress consent mode is enabled
  - `gcm_firebase_enabled` boolean — Whether Firebase SDK is enabled for GCM third-party SDKs
  - `gcm_airbridge_enabled` boolean — Whether Airbridge SDK is enabled for GCM third-party SDKs
  - `gcm_kochava_enabled` boolean — Whether Kochava SDK is enabled for GCM third-party SDKs
  - `gcm_branch_enabled` boolean — Whether Branch SDK is enabled for GCM third-party SDKs
  - `gcm_appsflyer_enabled` boolean — Whether AppsFlyer SDK is enabled for GCM third-party SDKs
  - `ctv_focus_on_agree_and_close` boolean — Whether the consent notice initial focus is on the Agree and Close button
  - `secure_cookies` boolean — Whether SDKs should create secure cookies on HTTPS websites
  - `gpp_enabled` boolean — Whether GPP is enabled
  - `gpp_mspa_signatory` boolean — Whether GPP MSPA signatory is enabled
  - `gpp_mspa_mode` 'service_provider' | 'opt_out' — GPP MSPA mode (service provider or opt out)
  - `gpp_mspa_generate_usnat_string` boolean — Whether to generate the US national string when MSPA is enabled
  - `deployed_at` string — Date of deployment of this configuration
  - `deployed_by` string — The ID of the user that deployed this configuration
  - `deployed_by_type` string — The type of an ID (deployed_by) that deployed the notice
  - `deployed_by_name` string — The name of the user that deployed this configuration
  - `deployed_metadata` object
    - `all_iab_enabled` boolean — Indicates whether all IAB vendors are selected
    - `iab_vendor_count` number — Count of custom-included IAB vendors (0 if all IAB vendors are selected)
    - `custom_vendor_count` string — Count of non-IAB vendors
    - `iab_purpose_count` object — Count of IAB purposes used by the selected vendors
    - `custom_purpose_count` object — Count of non-IAB purposes used by the selected vendors
  - `regulation_configurations` NoticesRegulationsConfig[]
    - `id` string, required — The ID of the configuration
    - `regulation_id` string, required — The ID of the regulation. This is a reference to the regulations service.
    - `organization_id` string, required — The ID of the organization that owns this configuration
    - `notice_config_id` string, required — The ID of the notice config that this configuration belongs to
    - `is_default_regulation_config` boolean — If this is the default configuration for a given regulation
    - `geo_locations` string[]
    - `regulation_settings` object — Regulation specific configuration of the notice regulation configuration
    - `config` object — Configuration of the notice
    - `template_id` string — The ID of the notice template associated with this notice. "null" if this notice does not use configuration from a template.
    - `enable_ignore_consent_before` boolean — Whether the consent must be recollected after a certain date.
    - `negative_action_link_format` 'text' | 'cross' — What format of negative action link should be displayed in the notice: Link with te text Continue without agreeing or link with the X icon.
    - `disagree_button_style` 'primary' | 'secondary' — The style of the Disagree button
    - `country` string — The country that the consent notice belongs to (two letter ISO code)
    - `notice_deny_applies_to_li` boolean — Do not keep legitimate interest enabled when the user disagrees in the notice
    - `preferences_deny_applies_to_li` boolean — Do not keep legitimate interest enabled when the user clicks on "Disagree to all" in the Preferences
    - `consent_duration` number — The duration that applies to collected consent. Consent is recollected after the expiration of the duration
    - `consent_duration_unit` 'months' | 'days' | 'seconds' — The unit of the consent duration
    - `denied_consent_duration` number — The duration that applies to fully negative consent. Consent is recollected after the expiration of the duration
    - `denied_consent_duration_unit` 'months' | 'days' | 'seconds' — The unit of the denied consent duration
    - `denied_consent_duration_custom` boolean — Whether the duration for denied consent is different from the generic
    - `cross_device_enabled` boolean — Whether the cross device feature is enabled
    - `cross_device_timeout` number — The timeout that applies to sync with consent notice
    - `gcm_enabled` boolean — Whether Google consent mode is enabled
    - `gcm_tcf_enabled` boolean — Whether the Google consent mode TCF integration is enabled
    - `gcm_set_default_status` boolean — Whether to set the default status for analytics and ads
    - `gcm_analytics_default_status` boolean — Default status for analytics in Google Consent Mode
    - `gcm_ads_default_status` boolean — Default status for ads in Google Consent Mode
    - `gcm_functionality_default_status` boolean — Default status for functionality of the website e.g. language settings in Google Consent Mode
    - `gcm_personalization_default_status` boolean — Default status for personalization in Google Consent Mode
    - `gcm_security_default_status` boolean — Default status for security in Google Consent Mode
    - `gcm_ad_user_data_default_status` boolean — Default status for ad user data in Google Consent Mode
    - `gcm_ad_personalization_default_status` boolean — Default status for ad personalization in Google Consent Mode
    - `microsoft_enabled` boolean — Whether Microsoft consent mode is enabled
    - `microsoft_set_default_status` boolean — Whether to set the default status for ad storage in Microsoft Consent Mode
    - `microsoft_ad_storage_default_status` boolean — Default status for ad storage in Microsoft Consent Mode
    - `microsoft_enable_tcf_advertiser_consent_mode` boolean — Whether to enable TCF advertiser consent mode in Microsoft Consent Mode
    - `amazon_enabled` boolean — Whether Amazon consent mode is enabled
    - `amazon_set_default_status` boolean — Whether to set the default status for ads/user data in Amazon Consent Mode
    - `amazon_ad_storage_default_status` boolean — Default status for ad storage in Amazon Consent Mode
    - `amazon_ad_user_data_default_status` boolean — Default status for ad user data in Amazon Consent Mode
    - `wordpress_enabled` boolean — Whether WordPress consent mode is enabled
    - `gcm_firebase_enabled` boolean — Whether Firebase SDK is enabled for GCM third-party SDKs
    - `gcm_airbridge_enabled` boolean — Whether Airbridge SDK is enabled for GCM third-party SDKs
    - `gcm_kochava_enabled` boolean — Whether Kochava SDK is enabled for GCM third-party SDKs
    - `gcm_branch_enabled` boolean — Whether Branch SDK is enabled for GCM third-party SDKs
    - `gcm_appsflyer_enabled` boolean — Whether AppsFlyer SDK is enabled for GCM third-party SDKs
    - `created_at` string, date-time — Creation date of the configuration
    - `updated_at` string, date-time — Last update date of the configuration
    - `disabled_at` string, date-time — If present represents when the Notice Regulation Config was disabled.
    - `version` number — Revision number of the configuration
    - `gpp_mspa_generate_usnat_string` boolean — Whether to generate the US national string when MSPA is enabled
    - `notice_disabled` boolean — Whether the notice is disabled
    - `notice_active_elements_order` object — The order of active elements in the notice
    - `dismiss_button_enabled` boolean — Whether the dismiss button (Agree & Close) is enabled
    - `preferences_title_enabled` boolean — Whether the title is enabled in the preferences view
    - `preferences_cross_button_enabled` boolean — Whether the cross button (top right) is enabled in the preferences view
    - `preferences_view_all_partners_button_enabled` boolean — Whether the view all partners button is enabled in the preferences view
    - `preferences_active_elements_order` object — The order of active elements in the preferences layer
  - `created_at` string, date-time — Creation date of the configuration
  - `updated_at` string, date-time — Last update date of the configuration
  - `version` number — Revision number of the configuration
  - `notice_disabled` boolean — Whether the notice is disabled
  - `consent_string_partners_encoding` string — The encoding selected for the partners section in the didomi consent string: One of "bit_field_2_bits", "ranges_u16", "ranges_fibonacci"
  - `consent_string_purposes_encoding` string — The encoding selected for the purposes section in the didomi consent string: One of "bit_field_2_bits", "ranges_u16", "ranges_fibonacci"
  - `enable_web_view` boolean — Whether the web view is enabled
  - `notice_active_elements_order` object — The order of active elements in the notice
  - `dismiss_button_enabled` boolean — Whether the dismiss button (Agree & Close) is enabled
  - `preferences_title_enabled` boolean — Whether the title is enabled in the preferences view
  - `preferences_cross_button_enabled` boolean — Whether the cross button (top right) is enabled in the preferences view
  - `preferences_view_all_partners_button_enabled` boolean — Whether the view all partners button is enabled in the preferences view
  - `preferences_active_elements_order` object — The order of active elements (buttons) in the preferences view

---

[API](https://skmtc.net/didomi/apis/didomi-api.md) · [All operations](https://skmtc.net/didomi/apis/didomi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/didomi/didomi-api/revisions/da6995016be8/schema)