Get consent banner
Get consent banner by ID
curl --request GET \
--url https://cookiechimp.com/api/v1/consent-banners/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://cookiechimp.com/api/v1/consent-banners/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://cookiechimp.com/api/v1/consent-banners/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://cookiechimp.com/api/v1/consent-banners/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://cookiechimp.com/api/v1/consent-banners/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://cookiechimp.com/api/v1/consent-banners/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://cookiechimp.com/api/v1/consent-banners/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
}
}{
"errors": [
{
"code": 401,
"message": "API key must belong to an account"
}
]
}{
"errors": [
{
"code": 404,
"message": "Record not found"
}
]
}{
"errors": [
{
"code": 429,
"message": "Too many requests. Please retry later."
}
]
}Authorizations
API token obtained from the login endpoint or the dashboard
Path Parameters
ID of the resource
Query Parameters
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.
Response
Consent banner
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.
Show child attributes
Show child attributes
{
"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"
}
Was this page helpful?
curl --request GET \
--url https://cookiechimp.com/api/v1/consent-banners/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://cookiechimp.com/api/v1/consent-banners/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://cookiechimp.com/api/v1/consent-banners/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://cookiechimp.com/api/v1/consent-banners/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://cookiechimp.com/api/v1/consent-banners/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://cookiechimp.com/api/v1/consent-banners/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://cookiechimp.com/api/v1/consent-banners/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
}
}{
"errors": [
{
"code": 401,
"message": "API key must belong to an account"
}
]
}{
"errors": [
{
"code": 404,
"message": "Record not found"
}
]
}{
"errors": [
{
"code": 429,
"message": "Too many requests. Please retry later."
}
]
}