Which account to act on, as the account's API id. Only meaningful for a
user API key, which may reach several accounts — an account key already
identifies exactly one and ignores this.
Accepted by the endpoints that declare it; others act on the account the
key resolves to on its own.
Optional for reads, where it narrows the request to that account.
Required for writes that declare it when the key can reach more than one
account: without it the request would act on an account it picked rather
than one you named, so it is refused with a 400.
Every setting the update endpoint accepts, plus the read-only fields
below — the response is derived from the same list the API permits, so a
banner can be read, edited and sent back unchanged.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"CookieChimp Docs","colors":{"primary":"#385be9","light":"#3f79f6","dark":"#385be9"},"logo":{"light":"https://mintcdn.com/identitysquare/apIhG7ZyseCffQHM/logo/light.svg?fit=max\u0026auto=format\u0026n=apIhG7ZyseCffQHM\u0026q=85\u0026s=31b0b52ff4d46777b33e7e8b711f82f1","dark":"https://mintcdn.com/identitysquare/apIhG7ZyseCffQHM/logo/dark.svg?fit=max\u0026auto=format\u0026n=apIhG7ZyseCffQHM\u0026q=85\u0026s=9b958393595f061d058bf1f7fee653a4"},"favicon":"https://mintcdn.com/identitysquare/PNp7zvpuSh_GT_4M/favicon.png?fit=max\u0026auto=format\u0026n=PNp7zvpuSh_GT_4M\u0026q=85\u0026s=0f1cf47c388e7991359a723a94c0dcaa","api":{"openapi":["openapi.yaml"]},"background":{"color":{"light":"#fafbfc","dark":"#1e1e1e"}},"navbar":{"primary":{"type":"button","label":"Get Started","href":"https://cookiechimp.com/users/sign_up"}},"footer":{"socials":{"twitter":"https://twitter.com/danielpaulme","github":"https://github.com/IdentitySquare/CookieChimp-Docs"},"links":[{"header":"Product","items":[{"label":"Features","href":"https://cookiechimp.com/"},{"label":"Integrations","href":"https://cookiechimp.com/"},{"label":"Pricing","href":"https://cookiechimp.com/pricing"}]},{"header":"Company","items":[{"label":"About","href":"https://cookiechimp.com"},{"label":"Blog","href":"https://cookiechimp.com/blog"},{"label":"Contact","href":"https://cookiechimp.com"}]}]},"icons":{"library":"lucide"},"styling":{"eyebrows":"section","latex":false},"integrations":{"intercom":{"appId":"r4jecam1"},"pirsch":{"id":"Vr5YSZNge2WlBW5CxGvi7U2UDRBNPCka"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Quick Start","icon":"rocket","color":{"light":"#9d59ef","dark":"#9d59ef"},"href":"https://cookiechimp.com/install"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"identitysquare","hasAudioNarration":false,"actualSubdomain":"identitysquare","customDomains":["docs.cookiechimp.com"],"gitSource":{"type":"github","owner":"identitysquare","repo":"cookiechimp-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae291ad3f0afb83782b5b7b","collectionId":"ac4dcb6c-2088-4f02-aea1-96a338ac8228","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae291ad3f0afb83782b5b7b"},"feedback":{"edits":true,"issues":true,"thumbs":true},"entitlements":{"REMOVE_BRANDING":{"status":"ENABLED"}},"buildId":"6ae291ad3f0afb83782b5b7b","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"API Reference","count":57},{"language":"default","tag":"Documentation","count":52},{"language":"default","tag":"Platform Specific Installation","count":23},{"language":"default","tag":"Consent SDK","count":16},{"language":"default","tag":"Integrations","count":11},{"language":"default","tag":"Website Builders","count":10},{"language":"default","tag":"Consent Banners","count":8},{"language":"default","tag":"SDK reference","count":8},{"language":"default","tag":"Advanced","count":7},{"language":"default","tag":"Get Started","count":7}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--rounded-md:5px;--rounded-lg:5px;--rounded-xl:12px;--rounded-2xl:18px;--rounded-full:300px}"}],"page":{"pagePath":"api-reference/consent-banners/get-consent-banner","slug":"/api-reference/consent-banners/get-consent-banner","pageMetadata":{"openapi":"get /consent-banners/{id}","playground":"simple","title":"Get consent banner","description":"Get consent banner by ID","href":"/api-reference/consent-banners/get-consent-banner"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Get consent banner by ID\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /consent-banners/{id}","playground":"simple","title":"Get consent banner","description":"Get consent banner by ID","href":"/api-reference/consent-banners/get-consent-banner"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/identitysquare/e3b0c44298fc1c14/script.js"],"openApiReferenceData":{"operation":{"summary":"Get consent banner","description":"Get consent banner by ID","operationId":"getConsentBanner","tags":["Consent Banners"],"parameters":["890716be-f1dd-4c89-9f50-09e50553f5a7","eba26cbe-1d8d-4ed1-8fc8-cf129cc6ce83"],"responses":{"200":"d5af3949-e9b0-4d97-9e10-950835840f27","401":"9ea54ea8-2e50-4230-98b5-870482b5c301","404":"480b960c-8386-4ef8-baf9-530f73c5d5de","429":"38ffb7fd-eac0-40b4-a63b-4572ba11bf83"},"method":"get","type":"path","servers":["debb5517-1214-4c27-8619-56b096d4e61e"],"security":["827a599a-6d67-40e7-90fd-5b28b08dee6a"],"path":"/consent-banners/{id}","baseUrlOptions":["https://cookiechimp.com/api/v1"],"title":"Get consent banner","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"890716be-f1dd-4c89-9f50-09e50553f5a7":{"name":"account_id","in":"query","description":"Which account to act on, as the account's API id. Only meaningful for a\nuser API key, which may reach several accounts — an account key already\nidentifies exactly one and ignores this.\n\nAccepted by the endpoints that declare it; others act on the account the\nkey resolves to on its own.\n\nOptional for reads, where it narrows the request to that account.\nRequired for writes that declare it when the key can reach more than one\naccount: without it the request would act on an account it picked rather\nthan one you named, so it is refused with a `400`.\n","required":false,"schema":{"type":"string","isRequired":false,"description":"Which account to act on, as the account's API id. Only meaningful for a\nuser API key, which may reach several accounts — an account key already\nidentifies exactly one and ignores this.\n\nAccepted by the endpoints that declare it; others act on the account the\nkey resolves to on its own.\n\nOptional for reads, where it narrows the request to that account.\nRequired for writes that declare it when the key can reach more than one\naccount: without it the request would act on an account it picked rather\nthan one you named, so it is refused with a `400`.\n","uniqueKey":"","typeLabel":"string"}},"eba26cbe-1d8d-4ed1-8fc8-cf129cc6ce83":{"name":"id","in":"path","description":"ID of the resource","required":true,"schema":{"type":"string","isRequired":true,"description":"ID of the resource","uniqueKey":"","typeLabel":"string"}}},"responses":{"d5af3949-e9b0-4d97-9e10-950835840f27":{"description":"Consent banner","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","description":"Every setting the update endpoint accepts, plus the read-only fields\nbelow — the response is derived from the same list the API permits, so a\nbanner can be read, edited and sent back unchanged.\n","example":{"id":"ban1","name":"EU banner","enabled":true,"enable_tcf":false,"force_consent":false,"consent_mode":"opt_in","consent_duration_days":180,"consent_layout":"box","consent_position":"bottom_center","consent_title":"We use cookies","consent_description":"We use cookies to improve your experience.","privacy_policy_url":"https://example.com/privacy","preferences_control_level":"category_and_services","dark_mode":"light","language_autodetect":"document","revision":2,"target_type":"selected_countries","target_countries":["DE","FR"],"target_us_states":[],"target_canadian_regions":[],"translations":[{"id":"trn1","language_code":"de"},{"id":"trn2","language_code":"fr"}],"created_at":"2023-01-05T10:15:30Z","updated_at":"2023-02-01T08:00:00Z"},"properties":{"banner_accept_btn_text":{"oneOf":[{"type":"string","uniqueKey":"data.banner_accept_btn_text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.banner_accept_btn_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.banner_accept_btn_text","typeLabel":"string | null"},"banner_accept_necessary_btn_text":{"oneOf":[{"type":"string","uniqueKey":"data.banner_accept_necessary_btn_text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.banner_accept_necessary_btn_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.banner_accept_necessary_btn_text","typeLabel":"string | null"},"banner_footer_content":{"oneOf":[{"type":"string","uniqueKey":"data.banner_footer_content.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.banner_footer_content.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.banner_footer_content","typeLabel":"string | null"},"banner_preferences_btn_text":{"oneOf":[{"type":"string","uniqueKey":"data.banner_preferences_btn_text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.banner_preferences_btn_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.banner_preferences_btn_text","typeLabel":"string | null"},"btn_border_radius":{"type":"string","uniqueKey":"data.btn_border_radius","typeLabel":"string"},"consent_additional_description":{"oneOf":[{"type":"string","uniqueKey":"data.consent_additional_description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.consent_additional_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.consent_additional_description","typeLabel":"string | null"},"consent_button_placement":{"type":"string","uniqueKey":"data.consent_button_placement","typeLabel":"string"},"consent_description":{"oneOf":[{"type":"string","uniqueKey":"data.consent_description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.consent_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.consent_description","typeLabel":"string | null"},"consent_duration_days":{"type":"integer","description":"How long a visitor's choice is remembered","uniqueKey":"data.consent_duration_days","typeLabel":"integer"},"consent_layout":{"type":"string","description":"e.g. `box`, `bar`","uniqueKey":"data.consent_layout","typeLabel":"string"},"consent_mode":{"type":"string","description":"e.g. `opt_in`, `opt_out`","uniqueKey":"data.consent_mode","typeLabel":"string"},"consent_position":{"type":"string","description":"e.g. `bottom_center`","uniqueKey":"data.consent_position","typeLabel":"string"},"consent_title":{"oneOf":[{"type":"string","uniqueKey":"data.consent_title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.consent_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.consent_title","typeLabel":"string | null"},"dark_mode":{"type":"string","description":"e.g. `light`, `dark`, `auto`","uniqueKey":"data.dark_mode","typeLabel":"string"},"do_not_sell_description":{"oneOf":[{"type":"string","uniqueKey":"data.do_not_sell_description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.do_not_sell_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.do_not_sell_description","typeLabel":"string | null"},"do_not_sell_title":{"oneOf":[{"type":"string","uniqueKey":"data.do_not_sell_title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.do_not_sell_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.do_not_sell_title","typeLabel":"string | null"},"enable_banner_footer":{"type":"boolean","uniqueKey":"data.enable_banner_footer","typeLabel":"boolean"},"enable_tcf":{"type":"boolean","description":"Whether the banner runs in IAB TCF mode","uniqueKey":"data.enable_tcf","typeLabel":"boolean"},"equal_weight_buttons":{"type":"boolean","uniqueKey":"data.equal_weight_buttons","typeLabel":"boolean"},"floating_preferences_icon_position":{"type":"string","uniqueKey":"data.floating_preferences_icon_position","typeLabel":"string"},"force_consent":{"type":"boolean","description":"Whether the page is blocked until the visitor chooses","uniqueKey":"data.force_consent","typeLabel":"boolean"},"language_autodetect":{"type":"string","uniqueKey":"data.language_autodetect","typeLabel":"string"},"logo_url_dark":{"oneOf":[{"type":"string","uniqueKey":"data.logo_url_dark.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.logo_url_dark.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.logo_url_dark","typeLabel":"string | null"},"logo_url_light":{"oneOf":[{"type":"string","uniqueKey":"data.logo_url_light.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.logo_url_light.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.logo_url_light","typeLabel":"string | null"},"modal_border_radius":{"type":"string","uniqueKey":"data.modal_border_radius","typeLabel":"string"},"name":{"type":"string","uniqueKey":"data.name","typeLabel":"string"},"preferences_accept_btn_text":{"oneOf":[{"type":"string","uniqueKey":"data.preferences_accept_btn_text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.preferences_accept_btn_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.preferences_accept_btn_text","typeLabel":"string | null"},"preferences_accept_necessary_btn_text":{"oneOf":[{"type":"string","uniqueKey":"data.preferences_accept_necessary_btn_text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.preferences_accept_necessary_btn_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.preferences_accept_necessary_btn_text","typeLabel":"string | null"},"preferences_control_level":{"type":"string","description":"How granular the preferences modal is","uniqueKey":"data.preferences_control_level","typeLabel":"string"},"privacy_policy_url":{"oneOf":[{"type":"string","uniqueKey":"data.privacy_policy_url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.privacy_policy_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.privacy_policy_url","typeLabel":"string | null"},"save_preferences_btn_text":{"oneOf":[{"type":"string","uniqueKey":"data.save_preferences_btn_text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.save_preferences_btn_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.save_preferences_btn_text","typeLabel":"string | null"},"settings_description":{"oneOf":[{"type":"string","uniqueKey":"data.settings_description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.settings_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.settings_description","typeLabel":"string | null"},"settings_layout":{"type":"string","uniqueKey":"data.settings_layout","typeLabel":"string"},"settings_more_info":{"oneOf":[{"type":"string","uniqueKey":"data.settings_more_info.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.settings_more_info.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.settings_more_info","typeLabel":"string | null"},"settings_more_info_title":{"oneOf":[{"type":"string","uniqueKey":"data.settings_more_info_title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.settings_more_info_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.settings_more_info_title","typeLabel":"string | null"},"settings_position_x":{"type":"string","uniqueKey":"data.settings_position_x","typeLabel":"string"},"settings_title":{"oneOf":[{"type":"string","uniqueKey":"data.settings_title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.settings_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.settings_title","typeLabel":"string | null"},"show_banner_accept_btn":{"type":"boolean","uniqueKey":"data.show_banner_accept_btn","typeLabel":"boolean"},"show_banner_accept_necessary_btn":{"type":"boolean","uniqueKey":"data.show_banner_accept_necessary_btn","typeLabel":"boolean"},"show_banner_close_btn":{"type":"boolean","uniqueKey":"data.show_banner_close_btn","typeLabel":"boolean"},"show_banner_preferences_btn":{"type":"boolean","uniqueKey":"data.show_banner_preferences_btn","typeLabel":"boolean"},"show_floating_preferences_icon":{"type":"boolean","uniqueKey":"data.show_floating_preferences_icon","typeLabel":"boolean"},"show_preferences_accept_btn":{"type":"boolean","uniqueKey":"data.show_preferences_accept_btn","typeLabel":"boolean"},"show_preferences_accept_necessary_btn":{"type":"boolean","uniqueKey":"data.show_preferences_accept_necessary_btn","typeLabel":"boolean"},"show_save_preferences_btn":{"type":"boolean","uniqueKey":"data.show_save_preferences_btn","typeLabel":"boolean"},"show_services":{"type":"boolean","uniqueKey":"data.show_services","typeLabel":"boolean"},"swap_buttons":{"type":"boolean","uniqueKey":"data.swap_buttons","typeLabel":"boolean"},"target_canadian_regions":{"type":"array","items":{"type":"string","uniqueKey":"data.target_canadian_regions.items.[INDEX]","typeLabel":"string"},"description":"Province and territory codes, used when `target_type` is `selected_canadian_provinces`. Shares a column with `target_us_states`.","uniqueKey":"data.target_canadian_regions","typeLabel":"string[]"},"target_countries":{"type":"array","items":{"type":"string","uniqueKey":"data.target_countries.items.[INDEX]","typeLabel":"string"},"description":"ISO 3166-1 alpha-2 codes","uniqueKey":"data.target_countries","typeLabel":"string[]"},"target_type":{"type":"string","description":"Who sees the banner, e.g. `worldwide`, `selected_countries`","uniqueKey":"data.target_type","typeLabel":"string"},"target_us_states":{"type":"array","items":{"type":"string","uniqueKey":"data.target_us_states.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.target_us_states","typeLabel":"string[]"},"button_colors":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.button_colors.additionalProperties","typeLabel":"string"},"description":"Colour overrides, keyed by button element","uniqueKey":"data.button_colors","typeLabel":"object"},"enabled":{"type":"boolean","description":"Whether the banner is live.","uniqueKey":"data.enabled","typeLabel":"boolean"},"id":{"type":"string","readOnly":true,"uniqueKey":"data.id","typeLabel":"string"},"revision":{"type":"integer","readOnly":true,"description":"Bumped when a change requires visitors to consent again","uniqueKey":"data.revision","typeLabel":"integer"},"translations":{"type":"array","readOnly":true,"description":"The banner's translations, each with its localized copy alongside\nits `id` — so a client can read what it is allowed to write rather\nthan overwriting fields it cannot see. The `id` is what you send\nback in `banner_languages_attributes` to update or discard one.\n","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"data.translations.items.[INDEX].id","typeLabel":"string"},"language_code":{"type":"string","description":"ISO 639-1 code","uniqueKey":"data.translations.items.[INDEX].language_code","typeLabel":"string"},"consent_title":{"oneOf":[{"type":"string","uniqueKey":"data.translations.items.[INDEX].consent_title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.translations.items.[INDEX].consent_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.translations.items.[INDEX].consent_title","typeLabel":"string | null"},"consent_description":{"oneOf":[{"type":"string","uniqueKey":"data.translations.items.[INDEX].consent_description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.translations.items.[INDEX].consent_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.translations.items.[INDEX].consent_description","typeLabel":"string | null"},"consent_additional_description":{"oneOf":[{"type":"string","uniqueKey":"data.translations.items.[INDEX].consent_additional_description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.translations.items.[INDEX].consent_additional_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.translations.items.[INDEX].consent_additional_description","typeLabel":"string | null"},"banner_accept_btn_text":{"oneOf":[{"type":"string","uniqueKey":"data.translations.items.[INDEX].banner_accept_btn_text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.translations.items.[INDEX].banner_accept_btn_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.translations.items.[INDEX].banner_accept_btn_text","typeLabel":"string | null"},"banner_accept_necessary_btn_text":{"oneOf":[{"type":"string","uniqueKey":"data.translations.items.[INDEX].banner_accept_necessary_btn_text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.translations.items.[INDEX].banner_accept_necessary_btn_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.translations.items.[INDEX].banner_accept_necessary_btn_text","typeLabel":"string | null"},"banner_preferences_btn_text":{"oneOf":[{"type":"string","uniqueKey":"data.translations.items.[INDEX].banner_preferences_btn_text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.translations.items.[INDEX].banner_preferences_btn_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.translations.items.[INDEX].banner_preferences_btn_text","typeLabel":"string | null"},"banner_footer_content":{"oneOf":[{"type":"string","uniqueKey":"data.translations.items.[INDEX].banner_footer_content.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.translations.items.[INDEX].banner_footer_content.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.translations.items.[INDEX].banner_footer_content","typeLabel":"string | null"},"settings_title":{"oneOf":[{"type":"string","uniqueKey":"data.translations.items.[INDEX].settings_title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.translations.items.[INDEX].settings_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.translations.items.[INDEX].settings_title","typeLabel":"string | null"},"settings_description":{"oneOf":[{"type":"string","uniqueKey":"data.translations.items.[INDEX].settings_description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.translations.items.[INDEX].settings_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.translations.items.[INDEX].settings_description","typeLabel":"string | null"},"settings_more_info_title":{"oneOf":[{"type":"string","uniqueKey":"data.translations.items.[INDEX].settings_more_info_title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.translations.items.[INDEX].settings_more_info_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.translations.items.[INDEX].settings_more_info_title","typeLabel":"string | null"},"settings_more_info":{"oneOf":[{"type":"string","uniqueKey":"data.translations.items.[INDEX].settings_more_info.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.translations.items.[INDEX].settings_more_info.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.translations.items.[INDEX].settings_more_info","typeLabel":"string | null"},"privacy_policy_url":{"oneOf":[{"type":"string","uniqueKey":"data.translations.items.[INDEX].privacy_policy_url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.translations.items.[INDEX].privacy_policy_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.translations.items.[INDEX].privacy_policy_url","typeLabel":"string | null"},"do_not_sell_title":{"oneOf":[{"type":"string","uniqueKey":"data.translations.items.[INDEX].do_not_sell_title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.translations.items.[INDEX].do_not_sell_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.translations.items.[INDEX].do_not_sell_title","typeLabel":"string | null"},"do_not_sell_description":{"oneOf":[{"type":"string","uniqueKey":"data.translations.items.[INDEX].do_not_sell_description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.translations.items.[INDEX].do_not_sell_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.translations.items.[INDEX].do_not_sell_description","typeLabel":"string | null"},"preferences_accept_btn_text":{"oneOf":[{"type":"string","uniqueKey":"data.translations.items.[INDEX].preferences_accept_btn_text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.translations.items.[INDEX].preferences_accept_btn_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.translations.items.[INDEX].preferences_accept_btn_text","typeLabel":"string | null"},"preferences_accept_necessary_btn_text":{"oneOf":[{"type":"string","uniqueKey":"data.translations.items.[INDEX].preferences_accept_necessary_btn_text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.translations.items.[INDEX].preferences_accept_necessary_btn_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.translations.items.[INDEX].preferences_accept_necessary_btn_text","typeLabel":"string | null"},"save_preferences_btn_text":{"oneOf":[{"type":"string","uniqueKey":"data.translations.items.[INDEX].save_preferences_btn_text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.translations.items.[INDEX].save_preferences_btn_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.translations.items.[INDEX].save_preferences_btn_text","typeLabel":"string | null"}},"uniqueKey":"data.translations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.translations","typeLabel":"object[]"},"created_at":{"type":"string","format":"date-time","readOnly":true,"uniqueKey":"data.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","readOnly":true,"uniqueKey":"data.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"ban1","name":"EU banner","enabled":true,"enable_tcf":false,"force_consent":false,"consent_mode":"opt_in","consent_duration_days":180,"consent_layout":"box","consent_position":"bottom_center","consent_title":"We use cookies","consent_description":"We use cookies to improve your experience.","privacy_policy_url":"https://example.com/privacy","preferences_control_level":"category_and_services","dark_mode":"light","language_autodetect":"document","revision":2,"target_type":"selected_countries","target_countries":["DE","FR"],"target_us_states":[],"target_canadian_regions":[],"translations":[{"id":"trn1","language_code":"de"},{"id":"trn2","language_code":"fr"}],"created_at":"2023-01-05T10:15:30Z","updated_at":"2023-02-01T08:00:00Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"9ea54ea8-2e50-4230-98b5-870482b5c301":{"description":"Missing or invalid API token, or a token that does not resolve to an\naccount. Account-scoped endpoints accept an account token, or a user\ntoken whose user belongs to an account; partner tokens are rejected.\n","content":{"application/json":{"schema":{"type":"object","description":"The standard error envelope, used for authentication, authorization,\npagination and not-found errors.\n","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"integer","uniqueKey":"errors.items.[INDEX].code","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"example":{"errors":[{"code":401,"message":"Invalid API Key"}]},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"code":401,"message":"API key must belong to an account"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":401,"message":"API key must belong to an account"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"480b960c-8386-4ef8-baf9-530f73c5d5de":{"description":"The record does not exist, or does not belong to the caller","content":{"application/json":{"schema":{"type":"object","description":"The standard error envelope, used for authentication, authorization,\npagination and not-found errors.\n","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"integer","uniqueKey":"errors.items.[INDEX].code","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"example":{"errors":[{"code":401,"message":"Invalid API Key"}]},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"code":404,"message":"Record not found"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":404,"message":"Record not found"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"38ffb7fd-eac0-40b4-a63b-4572ba11bf83":{"description":"Too many requests. The general limit is 300 requests per 5 minutes per\nAPI token; the auth endpoints are throttled more tightly per IP.\n","headers":{"Retry-After":{"description":"Seconds until the current rate-limit window resets","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","description":"The standard error envelope, used for authentication, authorization,\npagination and not-found errors.\n","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"integer","uniqueKey":"errors.items.[INDEX].code","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"example":{"errors":[{"code":401,"message":"Invalid API Key"}]},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"code":429,"message":"Too many requests. Please retry later."}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":429,"message":"Too many requests. Please retry later."}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"827a599a-6d67-40e7-90fd-5b28b08dee6a":{"authorization":{"type":"http","scheme":"bearer","description":"API token obtained from the login endpoint or the dashboard","scopes":[],"schemeName":"authorization"}}},"servers":{"debb5517-1214-4c27-8619-56b096d4e61e":{"url":"https://cookiechimp.com/api/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API token obtained from the login endpoint or the dashboard","scopes":[],"schemeName":"authorization"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API token obtained from the login endpoint or the dashboard","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"authorization","name":"Authorization"}],"title":"authorization"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"identitysquare","siteName":"CookieChimp Docs","title":"Get consent banner - CookieChimp Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T23:07:00.575Z","originalFileLocation":"api-reference/consent-banners/get-consent-banner.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Get consent banner by ID\">\u003cmeta data-mint-head name=\"application-name\" content=\"CookieChimp Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/identitysquare/BUv9cbu1a2hzyUu7/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/identitysquare/BUv9cbu1a2hzyUu7/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/identitysquare/BUv9cbu1a2hzyUu7/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/identitysquare/BUv9cbu1a2hzyUu7/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/identitysquare/BUv9cbu1a2hzyUu7/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/identitysquare/BUv9cbu1a2hzyUu7/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/identitysquare/BUv9cbu1a2hzyUu7/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/identitysquare/BUv9cbu1a2hzyUu7/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/identitysquare/BUv9cbu1a2hzyUu7/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get consent banner - CookieChimp Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get consent banner by ID\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"CookieChimp Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cookiechimp.com/docs/api-reference/consent-banners/get-consent-banner\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://identitysquare.mintlify.app/_mintlify/api/og/v2?division=Consent+Banners\u0026amp;title=Get+consent+banner\u0026amp;description=Get+consent+banner+by+ID\u0026amp;theme=a67172ce908334c5a9385457\u0026amp;signature=84bb68dd67732cc4a9d657e2805092dd42c476eb0d683a313e4e9bfe07ca19b3\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get consent banner - CookieChimp Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get consent banner by ID\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://identitysquare.mintlify.app/_mintlify/api/og/v2?division=Consent+Banners\u0026amp;title=Get+consent+banner\u0026amp;description=Get+consent+banner+by+ID\u0026amp;theme=a67172ce908334c5a9385457\u0026amp;signature=84bb68dd67732cc4a9d657e2805092dd42c476eb0d683a313e4e9bfe07ca19b3\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/identitysquare/BUv9cbu1a2hzyUu7/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"CookieChimp Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#385be9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cookiechimp.com/docs/api-reference/consent-banners/get-consent-banner\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/consent-banners/get-consent-banner.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cookiechimp.com/#organization\",\"name\":\"CookieChimp Docs\",\"url\":\"https://docs.cookiechimp.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/identitysquare/apIhG7ZyseCffQHM/logo/light.svg?fit=max\u0026auto=format\u0026n=apIhG7ZyseCffQHM\u0026q=85\u0026s=31b0b52ff4d46777b33e7e8b711f82f1\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cookiechimp.com/docs#website\",\"name\":\"CookieChimp Docs\",\"url\":\"https://docs.cookiechimp.com/docs\",\"publisher\":{\"@id\":\"https://docs.cookiechimp.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cookiechimp.com/docs/api-reference/consent-banners/get-consent-banner#webpage\",\"url\":\"https://docs.cookiechimp.com/docs/api-reference/consent-banners/get-consent-banner\",\"name\":\"Get consent banner\",\"description\":\"Get consent banner by ID\",\"dateModified\":\"2026-10-23T23:07:00.575Z\",\"isPartOf\":{\"@id\":\"https://docs.cookiechimp.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cookiechimp.com/docs/api-reference/consent-banners/get-consent-banner#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cookiechimp.com/docs/api-reference/consent-banners/get-consent-banner#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Consent Banners\",\"item\":\"https://docs.cookiechimp.com/docs/api-reference/consent-banners/list-consent-banners\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get consent banner\",\"item\":\"https://docs.cookiechimp.com/docs/api-reference/consent-banners/get-consent-banner\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cookiechimp.com/docs/api-reference/consent-banners/get-consent-banner#apireference\",\"headline\":\"Get consent banner\",\"name\":\"Get consent banner\",\"description\":\"Get consent banner by ID\",\"url\":\"https://docs.cookiechimp.com/docs/api-reference/consent-banners/get-consent-banner\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cookiechimp.com/docs/api-reference/consent-banners/get-consent-banner#webpage\"},\"dateModified\":\"2026-10-23T23:07:00.575Z\",\"publisher\":{\"@id\":\"https://docs.cookiechimp.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cookiechimp.com/docs#website\"}}]}\u003c/script>","siteName":"CookieChimp Docs","nav":{"global":{"anchors":[{"anchor":"Quick Start","icon":"rocket","color":{"light":"#9d59ef","dark":"#9d59ef"},"href":"https://cookiechimp.com/install"}]},"dropdowns":[{"dropdown":"Documentation","icon":"book","description":"Setup CookieChimp","groups":[{"group":"Get Started","pages":[{"title":"Overview","icon":"list","href":"/overview"},{"title":"Why Use a CMP?","icon":"circle-question-mark","href":"/why-use-a-cmp"},{"title":"Installation","icon":"download","href":"/installation/installation"},{"title":"How Long Does It Take to Set Up a CMP?","icon":"timer","href":"/installation/cmp-setup-guide"},{"title":"Block Scripts \u0026 Cookies","icon":"traffic-cone","href":"/block-scripts-cookies/script-attributes"},{"title":"Vendor List Embed","icon":"code","href":"/features/vendor-list-embed"},{"title":"FAQ","icon":"message-circle-question-mark","href":"/faq"}]},{"group":"Platform Specific Installation","pages":[{"title":"HTML","icon":"code","href":"/installation/html"},{"title":"Google Tag Manager","icon":"google","href":"/installation/google-tag-manager"},{"title":"WordPress","icon":"wordpress","href":"/installation/wordpress"},{"title":"Shopify","icon":"shopify","href":"/installation/shopify"},{"title":"Next.js","icon":"react","href":"/installation/nextjs"},{"title":"React","icon":"react","href":"/installation/react"},{"group":"JavaScript Frameworks","pages":[{"title":"Nuxt","icon":"vuejs","href":"/installation/nuxt"},{"title":"Angular","icon":"angular","href":"/installation/angular"},{"title":"Astro","icon":"rocket","href":"/installation/astro"},{"title":"SvelteKit","icon":"code","href":"/installation/sveltekit"},{"title":"Remix","icon":"react","href":"/installation/remix"},{"title":"JS \u0026 Single Page Apps","icon":"react","href":"/installation/single-page-applications"}]},{"group":"Website Builders","pages":[{"title":"Webflow","sidebarTitle":"Webflow","icon":"webflow","href":"/installation/webflow"},{"title":"Framer","sidebarTitle":"Framer","icon":"framer","href":"/installation/framer"},{"title":"Wix","sidebarTitle":"Wix","icon":"globe","href":"/installation/wix"},{"title":"Squarespace","sidebarTitle":"Squarespace","icon":"squarespace","href":"/installation/squarespace"},{"title":"Ghost","sidebarTitle":"Ghost","icon":"ghost","href":"/installation/ghost"},{"title":"Carrd","sidebarTitle":"Carrd","icon":"credit-card","href":"/installation/carrd"},{"title":"Duda","sidebarTitle":"Duda","icon":"layout-template","href":"/installation/duda"},{"title":"Bubble","sidebarTitle":"Bubble","icon":"circle-dot","href":"/installation/bubble"},{"title":"Weebly","sidebarTitle":"Weebly","icon":"globe","href":"/installation/weebly"},{"title":"Hostinger Website Builder","sidebarTitle":"Hostinger","icon":"server","href":"/installation/hostinger"}]},{"group":"Other Tag Managers","pages":[{"title":"Adobe Launch","icon":"adobe","iconType":"brands","href":"/installation/adobe-launch"}]}]},{"group":"Mobile Apps","pages":[{"title":"React Native","icon":"react","href":"/installation/react-native"}]},{"group":"Features","pages":[{"title":"Consent Records","href":"/features/consent-records"},{"title":"Vendor Scanning","href":"/features/vendor-scanning"},{"title":"Vendor Management","href":"/features/vendor-management"},{"title":"Banner Designer","href":"/features/banner-designer"},{"title":"Multilingual Banners","href":"/features/multilingual-banners"},{"title":"Wildcard Cookies","href":"/features/wildcard-cookies"}]},{"group":"Integrations","pages":[{"title":"Integrations Overview","icon":"plug","href":"/integrations/overview"},{"group":"Analytics \u0026 Advertising","pages":[{"title":"Google Consent Mode","icon":"google","href":"/integrations/google-consent-mode"},{"title":"Meta Consent API","icon":"facebook","href":"/integrations/meta-consent-api"},{"title":"Microsoft Clarity Consent Mode","icon":"chart-bar","href":"/integrations/microsoft-clarity"},{"title":"Microsoft UET Consent Mode","icon":"target","href":"/integrations/microsoft-uet"}]},{"group":"Platform APIs","pages":[{"title":"Shopify Customer Privacy API","icon":"shopify","href":"/integrations/shopify-privacy-api"},{"title":"WordPress Consent API","icon":"wordpress","href":"/integrations/wordpress-consent-api"}]},{"group":"Privacy Standards","pages":[{"title":"Global Privacy Control","icon":"shield-check","href":"/integrations/global-privacy-control"}]}]},{"group":"Advanced","pages":[{"title":"Block Iframes","href":"/features/block-iframes"},{"title":"Identify Users","href":"/features/identify-users"},{"title":"Custom Consent Button","href":"/advanced/custom-update-consent-button"},{"title":"Custom CSS","href":"/advanced/custom-css"},{"title":"JavaScript SDK","href":"/advanced/callbacks-events"},{"title":"Advanced Banner Overrides","href":"/advanced/banner-overrides"},{"title":"Content Security Policy (CSP)","href":"/advanced/content-security-policy"}]}]},{"dropdown":"Consent SDK","icon":"code","description":"React, Next.js, React Native and JavaScript consent SDK","groups":[{"group":"Get started","pages":[{"title":"Consent SDK","href":"/sdk/overview"},{"title":"Getting started","href":"/sdk/getting-started"},{"title":"Banner and vendor preferences","href":"/sdk/platform-ui"},{"title":"Connect to CookieChimp","href":"/sdk/connected-backend"},{"title":"Examples","href":"/sdk/examples"},{"title":"Versions and deployment","href":"/sdk/release-status"}]},{"group":"Mobile","pages":[{"title":"React Native","href":"/sdk/react-native"},{"title":"React Native vendor SDKs","href":"/sdk/react-native-integrations"}]},{"group":"SDK reference","pages":[{"title":"Core and React reference","href":"/sdk/reference"},{"title":"Next.js","href":"/sdk/nextjs"},{"title":"Script presets","href":"/sdk/scripts"},{"title":"Translations","href":"/sdk/translations"},{"title":"CLI","href":"/sdk/cli"},{"title":"Devtools","href":"/sdk/devtools"},{"title":"Design tokens","href":"/sdk/tokens"},{"title":"AI skills","href":"/sdk/ai-skills"}]}]},{"dropdown":"API Reference","icon":"terminal","description":"Reference for the API","groups":[{"group":"API Documentation","pages":[{"title":"API Overview \u0026 Authentication","href":"/api-reference/authentication"}]},{"group":"Auth","pages":[{"openapi":"post /auth","title":"Log in","href":"/api-reference/auth/login"},{"openapi":"delete /auth","title":"Log out","href":"/api-reference/auth/logout"},{"openapi":"put /password","title":"Change password","href":"/api-reference/auth/change-password"}]},{"group":"Partner Integration","pages":[{"title":"Partner API","href":"/api-reference/partner-api"},{"title":"Single Sign-On (SSO)","href":"/api-reference/sso"},{"title":"White-Labeling","href":"/api-reference/whitelabeling"}]},{"group":"Account","pages":[{"openapi":"get /accounts","title":"List accounts","href":"/api-reference/account/list-accounts"},{"openapi":"get /accounts/{id}","title":"Get account","href":"/api-reference/account/get-account"},{"openapi":"patch /accounts/{id}","playground":"simple","title":"Update account","href":"/api-reference/account/update-account"}]},{"group":"Consent Banners","pages":[{"openapi":"get /consent-banners","playground":"simple","title":"List consent banners","href":"/api-reference/consent-banners/list-consent-banners"},{"openapi":"post /consent-banners","playground":"simple","title":"Create consent banner","href":"/api-reference/consent-banners/create-consent-banner"},{"openapi":"get /banner-templates","playground":"simple","title":"List banner templates","href":"/api-reference/consent-banners/list-banner-templates"},{"openapi":"post /consent-banners/from-template","playground":"simple","title":"Create consent banner from a template","description":"Create a banner preconfigured for a jurisdiction — the consent mode,\ntargeting and copy that regulation requires. As with every banner this\nAPI creates, it starts disabled.\n\n`jurisdiction_id` comes from `GET /banner-templates`.\n","href":"/api-reference/consent-banners/create-consent-banner-from-template"},{"openapi":"get /consent-banners/{id}","playground":"simple","title":"Get consent banner","href":"/api-reference/consent-banners/get-consent-banner"},{"openapi":"put /consent-banners/{id}","playground":"simple","title":"Update consent banner","description":"Update a consent banner's content, appearance or targeting. Set\n`enabled` to `true` to make it live.\n","href":"/api-reference/consent-banners/update-consent-banner"},{"openapi":"post /consent-banners/{id}/duplicate","playground":"simple","title":"Duplicate consent banner","href":"/api-reference/consent-banners/duplicate-consent-banner"},{"openapi":"delete /consent-banners/{id}","playground":"simple","title":"Delete consent banner","href":"/api-reference/consent-banners/delete-consent-banner"}]},{"group":"Services","pages":[{"openapi":"get /services","playground":"simple","title":"List services","href":"/api-reference/services/list-services"},{"openapi":"post /services","playground":"simple","title":"Create service","href":"/api-reference/services/create-service"},{"openapi":"get /services/{id}","playground":"simple","title":"Get service","href":"/api-reference/services/get-service"},{"openapi":"put /services/{id}","playground":"simple","title":"Update service","href":"/api-reference/services/update-service"},{"openapi":"delete /services/{id}","playground":"simple","title":"Delete service","href":"/api-reference/services/delete-service"}]},{"group":"Compliance","pages":[{"openapi":"get /compliance","playground":"simple","title":"Get the regional compliance report","href":"/api-reference/compliance/get-compliance-report"}]},{"group":"Scans","pages":[{"openapi":"get /scans","playground":"simple","title":"List scans","href":"/api-reference/scans/list-scans"},{"openapi":"post /scans","playground":"simple","title":"Start a scan","href":"/api-reference/scans/create-scan"},{"openapi":"get /scans/{id}","playground":"simple","title":"Get scan","href":"/api-reference/scans/get-scan"}]},{"group":"Integrations","pages":[{"openapi":"get /integrations","playground":"simple","title":"List integrations","href":"/api-reference/integrations/list-integrations"},{"openapi":"get /integrations/{id}","playground":"simple","title":"Get integration","href":"/api-reference/integrations/get-integration"},{"openapi":"put /integrations/{id}","playground":"simple","title":"Update integration","href":"/api-reference/integrations/update-integration"}]},{"group":"Account Users","pages":[{"openapi":"get /account-users","title":"List account users","href":"/api-reference/account-users/list-account-users"},{"openapi":"get /account-users/{id}","title":"Get account user","href":"/api-reference/account-users/get-account-user"},{"openapi":"put /account-users/{id}","title":"Update account user","href":"/api-reference/account-users/update-account-user"},{"openapi":"delete /account-users/{id}","title":"Delete account user","href":"/api-reference/account-users/delete-account-user"}]},{"group":"Account Invitations","pages":[{"openapi":"get /account-invitations","title":"List account invitations","href":"/api-reference/account-invitations/list-account-invitations"},{"openapi":"post /account-invitations","title":"Create account invitation","href":"/api-reference/account-invitations/create-account-invitation"},{"openapi":"get /account-invitations/{id}","title":"Get account invitation","href":"/api-reference/account-invitations/get-account-invitation"},{"openapi":"put /account-invitations/{id}","title":"Update account invitation","href":"/api-reference/account-invitations/update-account-invitation"},{"openapi":"delete /account-invitations/{id}","title":"Delete account invitation","href":"/api-reference/account-invitations/delete-account-invitation"}]},{"group":"AI Actions","pages":[{"openapi":"get /ai-actions","title":"List AI actions","href":"/api-reference/ai-actions/list-ai-actions"},{"openapi":"get /ai-actions/{id}","title":"Get AI action","href":"/api-reference/ai-actions/get-ai-action"}]},{"group":"Storage Items","pages":[{"openapi":"get /storage-items","title":"List storage items","href":"/api-reference/storage-items/list-storage-items"},{"openapi":"post /storage-items","title":"Create storage item","href":"/api-reference/storage-items/create-storage-item"},{"openapi":"get /storage-items/{id}","title":"Get storage item","href":"/api-reference/storage-items/get-storage-item"},{"openapi":"put /storage-items/{id}","title":"Update storage item","href":"/api-reference/storage-items/update-storage-item"},{"openapi":"delete /storage-items/{id}","title":"Delete storage item","href":"/api-reference/storage-items/delete-storage-item"}]},{"group":"Categories","pages":[{"openapi":"get /categories","title":"List categories","href":"/api-reference/categories/list-categories"},{"openapi":"post /categories","title":"Create category","href":"/api-reference/categories/create-category"},{"openapi":"get /categories/{id}","title":"Get category","href":"/api-reference/categories/get-category"},{"openapi":"put /categories/{id}","title":"Update category","href":"/api-reference/categories/update-category"},{"openapi":"delete /categories/{id}","title":"Delete category","href":"/api-reference/categories/delete-category"}]},{"group":"Consents","pages":[{"openapi":"get /consents","title":"List consents","href":"/api-reference/consents/list-consents"},{"openapi":"get /consents/{id}","title":"Get consent","href":"/api-reference/consents/get-consent"}]},{"group":"Groups","pages":[{"openapi":"get /groups","title":"List groups","href":"/api-reference/groups/list-groups"},{"openapi":"get /groups/{id}","title":"Get group","href":"/api-reference/groups/get-group"},{"openapi":"post /groups","title":"Create group","href":"/api-reference/groups/create-group"},{"openapi":"put /groups/{id}","title":"Update group","href":"/api-reference/groups/update-group"}]}]}]},"title":"Get consent banner - CookieChimp Docs","buildId":"dpl_DGmhKsAzJdVqypJzon18vViniWRY","deploymentId":"dpl_DGmhKsAzJdVqypJzon18vViniWRY","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-2jF_ccbi.js","utils-NNMVb_sb.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DdtBhtt6.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D1OxL5O8.js","snippetPresets-DDC-KAXp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-FtoC8lZ9.js","ApiExamples-BOnTqOyQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-EEWI6FIO.js","shallow-fGZcWzm2.js","getApiPlaygroundDisplay-B3B8qEvw.js","CodeSnippet-BG9nsSU4.js","CodeSnippets-BlRACLKl.js","getPastedJson-COV-Kgnr.js","icon-BXu3lasn.js","MethodPill-DGMUqJKh.js","DuplicateIcon-JEUJDHz_.js","createIcon-BDFucJ34.js","DynamicMarkdown-34OtG_BH.js","SectionHeading-tBbRD59j.js","axios-vUo_bRtp.js","Markdown-SoRz2nk2.js","clsx-BOmkPVIU.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DN0dCbTw.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BcsLYcfW.js"]}