Data Attribute

List data attributes

GET/v4/config/consent/data-agreements/data-attributes

Lists the data attributes of all published data agreements of the organisation, as at their latest revision, one page at a time. Each item names its data agreement. Drafts that were never published are not in the list.

Give methodOfUse to list only the data attributes of data agreements with that method of use, or revisionId to list the data attributes of one data agreement revision. With revisionId the answer has another form: dataAttributes has one item, the array of all the data attributes of that revision (null when the revision has none), and pagination is always one page of one item. The server then ignores methodOfUse, offset and limit.

Language of the request sample

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

{
  "dataAttributes": [
    {
      "id": "6af0821c2d6fb7b6ac6efc7b",
      "name": "Purchase history",
      "description": "Products bought in the last 12 months",
      "sensitivity": false,
      "category": "Purchases",
      "dataAgreement": {
        "id": "6af0821c2d6fb7b6ac6efc78",
        "purpose": "Loyalty data sharing"
      }
    },
    {
      "id": "6af0818f2d6fb7b6ac6efc69",
      "name": "Email address",
      "description": "Email address to send the newsletter to",
      "sensitivity": false,
      "category": "Contact",
      "dataAgreement": {
        "id": "6af080eb2d6fb7b6ac6efc57",
        "purpose": "Newsletter"
      }
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalItems": 6,
    "totalPages": 3,
    "limit": 2,
    "hasPrevious": false,
    "hasNext": true
  }
}

Authorizations

Authorizationstringheaderrequired
Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.
Scope:data-agreements:read

Query parameters

revisionIdstring
Revision ID. Give it to get the record as it was at that revision. Without it, the server uses the latest revision.
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
methodOfUseenum<string>
Lists only the data agreements with this method of use.
Available options:null,data_source,data_using_service

Response

application/json

One page of data attributes.

dataAttributes(any or any[])[]
paginationobject