v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Consents

Get a consent

Get the details of a specific consent type, including its name and associated communication channels. Consent type IDs are used when reading or updating consent records on a customer. See Consent impact on segmentation and communication for details.

get/agreements/{agreement_id}

Path parameters

agreement_idstring required

The unique ID of a consent in CareCloud.

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Response

OK

Example response

{
  "data": {
    "agreement_id": "8fd73167342d06899c4c015320",
    "name": "Custom consent",
    "text": "<h1>Souhlas se zpracováním osobních údajů</h1><p>Tímto se dobrovolně a svobodně registruji do systému card a uděluji souhlas se zpracováním osobních údajů poskytnutých při registraci, jakožto i dalších osobních údajů získaných při obchodním styku a v souvislosti s členstvím v systému za účelem:</p><h2>Operací spojených s provozováním systému card</h2><ul><li>Zařazení do databáze členů card systému</li><li>Nabízení slev členům systému (zvýhodněné ceny a zboží, sbírání bodů)</li><li>Zasílání obchodních sdělení</li></ul>",
    "withdrawal_text": "<h1>Souhlas se zpracováním osobních údajů</h1><p>Tímto se dobrovolně a svobodně registruji do systému card a uděluji souhlas se zpracováním osobních údajů poskytnutých při registraci, jakožto i dalších osobních údajů získaných při obchodním styku a v souvislosti s členstvím v systému za účelem:</p><h2>Operací spojených s provozováním systému card</h2><ul><li>Zařazení do databáze členů card systému</li><li>Nabízení slev členům systému (zvýhodněné ceny a zboží, sbírání bodů)</li><li>Zasílání obchodních sdělení</li></ul>",
    "communication_channel_id": "86e05affc7a7abefcd513ab400",
    "text_id": "custom_consent",
    "last_change": "2021-12-16 17:42:28.248955"
  }
}