Get consent categories

/data/v2/projects/{projectToken}/consent/categories

Get the list of your consent categories and their definitions.

Use when you want to get a list of your existing consent categories and their properties, such as sources and translations. This is useful when rendering a consent form.

Definition

Authentication

In this API call you can use any of these 2 types of authorization accesses:

Available access typesPermissions needed
Public accessNone
Private accessNone

Read more about:

Path parameters

ParameterTypeDescriptionRequired
projectTokenstringThe ID of your project.required

Headers

ParameterTypeDescriptionRequired
authorizationstringUsed for authentication. Read more in the Authentication section.Required
content-typestringapplication/jsonRequired

Additional response example

{
    "results": [
        {
            "id": "other",
            "legitimate_interest": false,
            "sources": {
                "crm": true,
                "import": true,
                "list_unsubscribe": true,
                "page": true,
                "private_api": true,
                "public_api": false,
                "scenario": true,
                "sms_reply": true
            },
            "translations": {
                "": {
                    "description": null,
                    "name": "Other"
                }
            }
        },
        {
            "id": "newsletter",
            "legitimate_interest": false,
            "sources": {
                "crm": true,
                "import": true,
                "list_unsubscribe": true,
                "page": true,
                "private_api": true,
                "public_api": false,
                "scenario": true,
                "sms_reply": true
            },
            "translations": {
                "": {
                    "description": null,
                    "name": "Newsletter"
                }
            }
        },
        {
            "id": "paying_customer",
            "legitimate_interest": true,
            "sources": {
                "crm": true,
                "import": true,
                "list_unsubscribe": true,
                "page": true,
                "private_api": true,
                "public_api": false,
                "scenario": true,
                "sms_reply": true
            },
            "translations": {
                "": {
                    "description": null,
                    "name": "Soft opt-in"
                }
            }
        }
    ],
    "success": true
}
Language
Click Try It! to start a request and see the response here!