Get all consents
Get a list of all consent types configured in the CareCloud platform. Consents are the primary mechanism for GDPR compliance - they control which customers are eligible to receive marketing communications and which can be included in segmented audiences. Three consent types exist by default: processing of personal data, marketing communication, and profiling. The communication_channel_id filter returns only consents associated with a specific channel. See Consent impact on segmentation and communication for details.
Query parameters
The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.
The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.
Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.
Direction of sorting the response list.
The unique ID of the communication channel. List of values is available in resource GET /communication-channels.
You can filter resource results depending on his text ID.
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"agreements": [
{
"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"
}
],
"total_items": 1
}
}