List consent records of a data agreement
Lists the consent records of the individual for one data agreement, one page at a time. An individual has at most one consent record for each data agreement, so the list has zero or one item.
Authorizations
AuthorizationstringheaderrequiredYour API key with the prefix
ApiKey:ApiKey <your-api-key>. Get an API key.Scope:
consent-records:read
Path parameters
dataAgreement Id stringrequiredData agreement ID.
Example:
"6af080eb2d6fb7b6ac6efc57"
Query parameters
offsetintegerNumber of records to skip for pagination. A negative or unreadable value falls back to
0.At least 0.
Default:
0limitintegerMaximum number of records to return per page.
Default:
10
Headers
X-Consent BB- Individual Id stringID of the individual, or its
externalId. Mandatory with an API key: without it the answer is400("IndividualId is not present in request header"), and an unknown individual gets400too. With an individual token, leave it out: the server takes the individual from the token. Send it only on the routes that list it: with an API key that has resource scopes (for exampleconsent-records:read), another route answers400to a request with this header.Example:
"6af081b138e8f33dcf799628"
Response
One page of consent records.
consentRecords object[]paginationobject