List data agreements
Lists the published data agreements of the organisation, as at their latest revision, one page at a time. Use it to show the purposes that an individual can consent to, for example in a privacy dashboard or a consent banner. Drafts are not in the list. Give revisionId to get only the data agreement as it was at that revision.
Authorizations
AuthorizationstringheaderrequiredYour API key with the prefix
ApiKey:ApiKey <your-api-key>. Get an API key.Scope:
data-agreements:read
Query parameters
revisionId stringRevision ID. Give it to get the record as it was at that revision. Without it, the server uses the latest revision.
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
Response
One page of published data agreements.
dataAgreements object[] | nullThe data agreements of this page.
null, not an empty list, when there is none.paginationobject