Skip to main content
Data Agreement

List data attributes of a data agreement

GET/v4/service/consent/data-agreement/{dataAgreementId}/data-attributes

Lists the data attributes of a data agreement, as at its latest revision, one page at a time, together with the data agreement. Give revisionId to get the data attributes of an earlier revision.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:data-agreements:read

Path parameters

  • dataAgreementIdstringrequired

    Data agreement ID.

    Example:"6af080eb2d6fb7b6ac6efc57"

Query parameters

  • offsetinteger

    Number of records to skip for pagination. A negative or unreadable value falls back to 0.

    At least 0.

    Default:0

  • limitinteger

    Maximum number of records to return per page.

    Default:10

  • revisionIdstring

    Revision ID. Give it to get the record as it was at that revision. Without it, the server uses the latest revision.

Response

application/json

The data agreement and one page of its data attributes.

  • dataAgreementobject

    A data agreement describes one purpose for which the organisation processes personal data (ISO/IEC TS 27560). Many individuals can consent to the same data agreement: each consent is a consent record.

  • dataAttributesobject[]
  • paginationobject