LIST - List all active data agreements
GET {{baseUrl}}/service/data-agreements?revisionId=<string>&offset=<integer>&limit=10
This endpoint is used to list all active data agreements by the organisation in consent building block. The results are returned with pagination.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
revisionId | string | An object with id revisionId | |
offset | string | Requested index for start of resources to be provided in response requested by client | |
limit | number | Number of items returned per page. Requested number of resources to be provided in response requested by client |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"dataAgreements":[{"purpose":"\u003cstring\u003e","purposeDescription":"\u003cstring\u003e","controllerUrl":"\u003cstring\u003e","controllerName":"\u003cstring\u003e","policy":{"thirdPartyDataSharing":"\u003cbool\u003e"},"lifecycle":"\u003cstring\u003e","controllerId":"\u003cstring\u003e","dataAttributes":[{"value":"\u003cError: Could not resolve allOf schema"},{"value":"\u003cError: Could not resolve allOf schema"}],"dpiaSummaryUrl":"\u003cstring\u003e","signature":{}},{"purpose":"\u003cstring\u003e","purposeDescription":"\u003cstring\u003e","controllerUrl":"\u003cstring\u003e","controllerName":"\u003cstring\u003e","policy":{"thirdPartyDataSharing":"\u003cbool\u003e"},"lifecycle":"\u003cstring\u003e","controllerId":"\u003cstring\u003e","dataAttributes":[{"value":"\u003cError: Could not resolve allOf schema"},{"value":"\u003cError: Could not resolve allOf schema"}],"dpiaSummaryUrl":"\u003cstring\u003e","signature":{}}],"pagination":{"currentPage":"\u003cinteger\u003e","totalItems":"\u003cinteger\u003e","totalPages":"\u003cinteger\u003e","limit":"\u003cinteger\u003e","hasPrevious":"\u003cboolean\u003e","hasNext":"\u003cboolean\u003e"}}