List consent groups

Production

https://api.mediaconnect.no/capi

GET

/v1/customer/privacy/consentGroups/{issuer}

The user needs to be logged in to use this endpoint, click here to read more.

API for getting consent group.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.mediaconnect.no/capi/v1/customer/privacy/consentGroups/?onlyActive'

Response Example

200 - Success

{
    "issuer": "468979834",
    "groups": [
        {
            "consentGroupId": 1,
            "created": 1560851788000,
            "selectionOrder": 2,
            "texts": [
                {
                    "languageCode": "en_GB",
                    "name": "Digital Communication",
                    "description": "Consent for digital communication"
                },
                {
                    "languageCode": "nb_NO",
                    "name": "Digital kommunikasjon",
                    "description": "Samtykke for digital kommunikasjon"
                }
            ],
            "active": true
        }
    ]
}

Request

Authorization

OAuth 2.0

Authorization Code

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Authorize URL: https://connectid.no/user/oauth/authorize

Token URL: https://connectid.no/user/oauth/token

Refresh URL: https://connectid.no/user/oauth/token

Scopes:

read-For all access

Path Params

issuer

string

required

Identification of the issuer principal of the consent.

<= 255 characters

Query Params

onlyActive

boolean

optional

Whether to return active records or all the data:

true: It returns data only for active records.

false: It returns all the data.

Default:

true

Responses

🟢200OK

application/json

Body

issuer

string

optional

Used to identify who has required the consent, ex. name of the company.

<= 255 characters

groups

array [object {5}]

optional

Used to structure the consents that belongs together based on your choice.

consentGroupId

integer

optional

The identfication number of a gruop of consents.

created

integer

optional

Group creation date.

Unix Epoch timestamps in milliseconds since 1st January 1970 UTC.

selectionOrder

integer

optional

Selection order for display

texts

array [object {3}]

optional

A consent text for group of consents in different language.

active

boolean

optional

It informs if the consent group is in use.

true: The consent group is in use.

false: The consent group is not in use.

🟠400Bad Request

🟠429Too Many Requests

🔴500Server Error

Modified at 2025-05-06 09:58:53

List consent given issuer