Get consents items by query

curl --request POST \
  --url https://{host}/consent/v1/Consents/searches \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "take": 500,
  "skip": 1073741823,
  "consentIds": [
    "<string>"
  ],
  "consentKeys": [
    "<string>"
  ],
  "isActive": true,
  "isPublished": true
}
'

import requests

url = "https://{host}/consent/v1/Consents/searches"

payload = {
    "take": 500,
    "skip": 1073741823,
    "consentIds": ["<string>"],
    "consentKeys": ["<string>"],
    "isActive": True,
    "isPublished": True
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    take: 500,
    skip: 1073741823,
    consentIds: ['<string>'],
    consentKeys: ['<string>'],
    isActive: true,
    isPublished: true
  })
};

fetch('https://{host}/consent/v1/Consents/searches', 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/searches",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'take' => 500,
    'skip' => 1073741823,
    'consentIds' => [
        '<string>'
    ],
    'consentKeys' => [
        '<string>'
    ],
    'isActive' => true,
    'isPublished' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/consent/v1/Consents/searches"

	payload := strings.NewReader("{\n  \"take\": 500,\n  \"skip\": 1073741823,\n  \"consentIds\": [\n    \"<string>\"\n  ],\n  \"consentKeys\": [\n    \"<string>\"\n  ],\n  \"isActive\": true,\n  \"isPublished\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/consent/v1/Consents/searches")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"take\": 500,\n  \"skip\": 1073741823,\n  \"consentIds\": [\n    \"<string>\"\n  ],\n  \"consentKeys\": [\n    \"<string>\"\n  ],\n  \"isActive\": true,\n  \"isPublished\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"take\": 500,\n  \"skip\": 1073741823,\n  \"consentIds\": [\n    \"<string>\"\n  ],\n  \"consentKeys\": [\n    \"<string>\"\n  ],\n  \"isActive\": true,\n  \"isPublished\": true\n}"

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

{
  "consents": [
    {
      "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
}

POST

Consents

searches

Get consents items by query

curl --request POST \
  --url https://{host}/consent/v1/Consents/searches \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "take": 500,
  "skip": 1073741823,
  "consentIds": [
    "<string>"
  ],
  "consentKeys": [
    "<string>"
  ],
  "isActive": true,
  "isPublished": true
}
'

import requests

url = "https://{host}/consent/v1/Consents/searches"

payload = {
    "take": 500,
    "skip": 1073741823,
    "consentIds": ["<string>"],
    "consentKeys": ["<string>"],
    "isActive": True,
    "isPublished": True
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    take: 500,
    skip: 1073741823,
    consentIds: ['<string>'],
    consentKeys: ['<string>'],
    isActive: true,
    isPublished: true
  })
};

fetch('https://{host}/consent/v1/Consents/searches', 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/searches",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'take' => 500,
    'skip' => 1073741823,
    'consentIds' => [
        '<string>'
    ],
    'consentKeys' => [
        '<string>'
    ],
    'isActive' => true,
    'isPublished' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/consent/v1/Consents/searches"

	payload := strings.NewReader("{\n  \"take\": 500,\n  \"skip\": 1073741823,\n  \"consentIds\": [\n    \"<string>\"\n  ],\n  \"consentKeys\": [\n    \"<string>\"\n  ],\n  \"isActive\": true,\n  \"isPublished\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/consent/v1/Consents/searches")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"take\": 500,\n  \"skip\": 1073741823,\n  \"consentIds\": [\n    \"<string>\"\n  ],\n  \"consentKeys\": [\n    \"<string>\"\n  ],\n  \"isActive\": true,\n  \"isPublished\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"take\": 500,\n  \"skip\": 1073741823,\n  \"consentIds\": [\n    \"<string>\"\n  ],\n  \"consentKeys\": [\n    \"<string>\"\n  ],\n  \"isActive\": true,\n  \"isPublished\": true\n}"

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

{
  "consents": [
    {
      "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
}

Authorizations

Authorization

string

header

required

Headers

Accept-Language

string

default:en

Language code for localized content

Body

application/json

Query parameters including consent IDs, keys, and filters

Contract for querying consents by parameters

take

integer<int32>

required

Gets or sets value for how many records return (per page).

Required range: 1 <= x <= 1000

skip

integer<int32> | null

Gets or sets value for how many records skip.

Required range: 0 <= x <= 2147483647

Consent identifiers

Consent keys

isActive

boolean | null

Filter by active status (true for active, false for inactive, null for all)

isPublished

boolean | null

Filter by published status (true for published, false for unpublished, null for all)

Response

ConsentApi.Dto.Common.ConsentBulkDto object

consents

object[] | null

Array of consent items

Show child attributes

Last modified on August 10, 2026

⌘I