---
id: config-list-data-attribute
title: "Read data attributes"
description: "This endpoint reads all data attrinbutes defined in a data agreement."
sidebar_label: "Read data attributes"
hide_title: true
hide_table_of_contents: true
api: eJzdWNtuGzcQ/RViX5oAulmOm0AIgjpxEqhNXSN20IfYgKnd0S7jFbkhuZJVQW/9kn5av6Qz3PvFsR20L32xV7zMnLnPcOcFYHwtEiuU9GbeRSQMAxkkSkjLNPDAMB7HLOCWM26tFnKRWjAsgKWQEDAhGc93Qw2wAmlH3sBTCWhONOcBUvWVXIrwgzD2BE8eExmigucSrvkKLGjjzT7vWmA+SfE1BTY/YWrJuGRq8QV8i7cE7SbcRvgt8T7+IgjHBQJkOvA0fE2FBuRvdQoDz/gRrLg323l2m9AVQ9KE3n4/aDM+TVcL0MRVg6806sAqZm5EwpZKs4SHQjrhRuyYSQjxew0Md1JJGuOLGNiaxwh9ibozbMH9G6JwPbkeFehRML2t4Kvl0oBtoMa7pg82GgZC0HgWbcDT2HqzycBbCSlW6Qq/nTw52VishG2zbMr6K7+li0z2yazBployNCZJDaPvBXiAqK7orkmUNGDo9HQyoX/oGxZNRp88SWLhO82OvxhCt6tRTzQ5lRXZ7aDuSG5FWFi5D9T5b0vnTjmg0m+akp+UPp25NCHh6M8mAV8scyCGNAK33Lfxlm0ibpmgk3GMFCEghdwOpbJDIYcEacENlJqpVPU5M0gTASqkKZMIut458NDlVhz14+E3AlklMW3/ePTs+cF0OoUX/nP/cLE49Kf+i6PJwT1SYjB5+8LrHsrrtIs9WyTd2Agq8gMXIEIay6UP7NIxuvQoNi49dKBLj7g3CD0UxLsU05CsMRUyEGsRpDzuylz96kAkAAakERi0wm5rABZKxcDlXQhyozY5nVeUiFPQUDaxQi+CUOntwwU9w2SoZI9Ub3JS/YyMr5JH2JQSVYfDOdFghds6W7YZuezSE4pF6q0hKMPufi9H/EmqE2V6JNgTzxbN/VW1xLXmW0ehzMt9IKywmXqrU21kfqo1ioAn4I501jBHdtolxjx71jV8QAiV5fG8yEv30Lugw7U07PIZ42suYqooddrTo4I4Yf0e4gSaCpNBM2OQFHWi5HCIDLLF+2mftiAX1aKhjQkSjLg507AWKjW9YdckO8f4pugxTLgQ1vADqoMlOYUOCxefGZdTuLXfz0Hi7Q516iF6PXHfTmidulKFUREkqG+D1YOZ1PfBmCWmNirMEcak64R2RPRZVh+btBecWq4kJYB559Rz8eBRhbVepkBrpd+owMlO3yfNgvXt0K5u93lNqUuUbN9Dvid3VfnqdY/g+32P9j9JntpIafEHBB3VHD2y5/h/qWaO/DRWFmZArzFIHZuWjlx1xEToSiO2UMeJ+AXo84oS/2vgGvQxKtitkNQ8pNY9c/qqs8cdBBIp6v5D19i6dn3mjbNZYEwBMSwDYrxr9e/7/EDV4REuQt03KJzASuVC4blUx7gWWZuY2Xgc4N6QJ2IkQs1xOBFqvJ563Z7/3FJhCO8iY7LtHkpXlcbOyXEyexd6Kw3Hs4W8F89UXvX/x7nPFoWpie34bM5uYMvIs1E9ub+O2EVUDBp5l3PdoHPNMjZslRrLFkC5cyluMfFshI3wsIPErtkT7GDBEbAay41TQ8J9eDpgMApHLbIzll98uVWpJo0MEdwrnG3QeeoesvMW7te7ogP5+feLrmwuBeKwcQM4aHBjCngZpRwzzZkNEKzUoItWl+bdBa+MRDIdTXeo8aUqwh4beReOK5STwilNEqXtT6VJK5OI99VS0xeqw50QKy+xJ3//+ddTGhY4O99AIEyUFQG49SMusWXgMmDoaeWk4TxP+GQlhX0t6BGbW5bitIQ78XJoFJ4GEUqGm+gEdjvI77uB08c0RctYBQc0kotQUMnf4DQE1jEzKhYBS1TALPiRVLEKMTmhiSUSIJtT6duwGNYQu2pO6cIN8gv0CWxwiQi6oEJj0nFfYQISrtF3BnPiaQjTOJ+c3NuAK254LUA4hHPFpUTZPOovfOyeXUIsogCdDp1wOpp0dL7ZbEbcbY+UDsf5XTP+MH/z9vT87ZDu7Ksur7IDxU6g/JTyShFdlEYye00n02ejw9GB6x+VsYiuhucj+lirAzZtB65Vk3/t9SR3YIuNyDiJcSYleE4fuzyPfs7fVAhNI5Piwqz7FtJOppizIpSW6Ox21AV+0vF+T8vZI4FLscKQwYL+yacu9n/7XNKrjBvKrdWribtOI47L6w8G/ti3j29AKTroCskV/dAuOB+pzycf87bjKbvzCawXSlFq5LaOpIDYdgs3ROVplABmpygfJ3VJOh3Svl7c37+llM7zfF/VuhtX6/KP2ltME1u77GUQ6C8ZsvfKSwporD6vyuPZzp0XykKRnSZNXWGf8w+B4Ead
sidebar_class_name: "get api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read data attributes</h1>

<MethodEndpoint method={"get"} path={"/config/data-agreement/{dataAgreementId}/data-attributes"}></MethodEndpoint>



This endpoint reads all data attrinbutes defined in a data agreement.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"dataAgreementId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination. A negative or unreadable value falls back to `0`.","in":"query","name":"offset","required":false,"schema":{"type":"integer","default":0,"minimum":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data attributes for data agreement listed successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"dataAttributes"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"items":{"allOf":[{"type":"object","description":"Data attributes contain specifications of exactly what is collected.","x-not-in-database":false,"required":["name","description"],"properties":{"id":{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"},"name":{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""},"description":{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"},"sensitivity":{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"},"category":{"type":"string","format":"","example":"Personal","description":"Category of data attribute"},"scope":{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}},{"properties":{"dataAgreement":{"type":"object","properties":{"id":{"type":"string"},"purpose":{"type":"string"}}}},"type":"object"}]},"type":"array"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataAttributes\": [\n    {\n      \"id\": \"65471222e8c7c3bb3c2c8501\",\n      \"name\": \"Name\",\n      \"description\": \"Full name of the individual\",\n      \"sensitivity\": false,\n      \"category\": \"Personal\",\n      \"scope\": \"read\",\n      \"dataAgreement\": {\n        \"id\": \"string\",\n        \"purpose\": \"string\"\n      }\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>