Get single consent by id

curl --request GET \
  --url https://{host}/consent/v1/Consents/{id} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://{host}/consent/v1/Consents/{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://{host}/consent/v1/Consents/{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: <api-key>"
  ],
]);

$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://{host}/consent/v1/Consents/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/consent/v1/Consents/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "agreement.cpl_0",
  "key": "agreement.cpl",
  "name": "<string>",
  "component": "<string>",
  "version": 123,
  "revision": 123,
  "contentUrl": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "effectiveAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "consentType": "Regular",
  "iconUrl": "<string>"
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

GET

Consents

{id}

Get single consent by id

curl --request GET \
  --url https://{host}/consent/v1/Consents/{id} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://{host}/consent/v1/Consents/{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://{host}/consent/v1/Consents/{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: <api-key>"
  ],
]);

$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://{host}/consent/v1/Consents/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/consent/v1/Consents/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "agreement.cpl_0",
  "key": "agreement.cpl",
  "name": "<string>",
  "component": "<string>",
  "version": 123,
  "revision": 123,
  "contentUrl": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "effectiveAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "consentType": "Regular",
  "iconUrl": "<string>"
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

Authorizations

Authorization

string

header

required

Headers

Accept-Language

string

default:en

Language code for localized content

Path Parameters

string

required

Consent unique identifier

Response

Single consent

DTO, represents consent instance

string

required

Consent unique identifier (across all consent types and versions)

Minimum string length: 1

Example:

"agreement.cpl_0"

key

string

required

Consent key, which is unique across different consent types

Minimum string length: 1

Example:

"agreement.cpl"

name

string

required

Name

Minimum string length: 1

component

string

required

Component to which consent corresponds

Minimum string length: 1

version

integer<int32>

required

Version

revision

integer<int32>

required

Revision

contentUrl

string

required

Url to consent content

Minimum string length: 1

createdAt

string<date-time>

required

Consent creation date

effectiveAt

string<date-time>

required

Consent effective from date

expiresAt

string<date-time>

required

Consent expiration date

Defines the type of consent

Available options:

Regular,

Agreement

iconUrl

string | null

Url to consent icon

Last modified on August 10, 2026

⌘I