Data Attribute

List data attributes of a data agreement

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

Lists the data attributes of one data agreement in its current state (also a draft), one page at a time. Each item also names its data agreement.

Language of the request sample

curl 'https://demo-api.igrant.io/v4/config/consent/data-agreement/6af080eb2d6fb7b6ac6efc57/data-attributes' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "dataAttributes": [
    {
      "id": "6af0818f2d6fb7b6ac6efc69",
      "name": "Email address",
      "description": "Email address to send the newsletter to",
      "sensitivity": false,
      "category": "Contact",
      "dataAgreement": {
        "id": "6af080eb2d6fb7b6ac6efc57",
        "purpose": "Newsletter"
      }
    },
    {
      "id": "6af0818f2d6fb7b6ac6efc6a",
      "name": "Preferred language",
      "description": "Language of the newsletter",
      "sensitivity": false,
      "category": "Preferences",
      "dataAgreement": {
        "id": "6af080eb2d6fb7b6ac6efc57",
        "purpose": "Newsletter"
      }
    },
    {
      "id": "6af081a12d6fb7b6ac6efc6d",
      "name": "First name",
      "description": "First name to greet the reader in the newsletter",
      "sensitivity": false,
      "category": "Contact",
      "dataAgreement": {
        "id": "6af080eb2d6fb7b6ac6efc57",
        "purpose": "Newsletter"
      }
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalItems": 3,
    "totalPages": 1,
    "limit": 10,
    "hasPrevious": false,
    "hasNext": false
  }
}

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

Response

application/json

One page of data attributes.

dataAttributesobject[]
paginationobject