Agreement records

List revisions of all data disclosure agreement records

GET/v4/config/consent/data-disclosure-agreement/records/revisions

Lists the revisions of all data disclosure agreement records of your organisation in one role, newest first. It is the full audit trail of signatures, opt-ins and opt-outs. Add dataDisclosureAgreementTemplateRevisionId to get only the revisions of records that are based on one template revision.

Errors: 400 when organisationRole is missing or the pagination parameters are not valid; 404 when the template revision does not exist.

Language of the request sample

curl 'https://demo-api.igrant.io/v4/config/consent/data-disclosure-agreement/records/revisions?organisationRole=data_source' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "revisions": [
    {
      "id": "6af1c0ab2d6fb7b6ac6efd27",
      "schemaName": "DataDisclosureAgreementRecord",
      "objectId": "6af1c0a12d6fb7b6ac6efd20",
      "signedWithoutObjectId": false,
      "timestamp": "2026-11-08T14:20:11Z",
      "authorizedByIndividualId": "",
      "authorizedByOther": "6ae2bf741c3dadfeb27982ec",
      "predecessorHash": "a8138b18a0a66de72ddaa42be8a88bb45a22754d",
      "predecessorSignature": "",
      "objectData": "{\"id\":\"6af1c0a12d6fb7b6ac6efd20\",\"canonicalId\":\"6af1c0a12d6fb7b6ac6efd20\",\"optIn\":true,\"timestamp\":\"2026-11-08T14:20:11Z\",\"organisationRole\":\"data_source\",...}",
      "successorId": "",
      "serializedHash": "d36253add1431c9588aa4d38b9fd774e1cfcbdfb",
      "serializedSnapshot": "{\"schemaName\":\"DataDisclosureAgreementRecord\",\"objectId\":\"6af1c0a12d6fb7b6ac6efd20\",\"timestamp\":\"2026-11-08T14:20:11Z\",...}",
      "organisationId": "6ae2bf741c3dadfeb27982ec"
    },
    {
      "id": "6af1c0a12d6fb7b6ac6efd21",
      "schemaName": "DataDisclosureAgreementRecord",
      "objectId": "6af1c0a12d6fb7b6ac6efd20",
      "signedWithoutObjectId": false,
      "timestamp": "2026-11-08T14:20:01Z",
      "authorizedByIndividualId": "",
      "authorizedByOther": "6ae2bf741c3dadfeb27982ec",
      "predecessorHash": "",
      "predecessorSignature": "",
      "objectData": "{\"id\":\"6af1c0a12d6fb7b6ac6efd20\",\"canonicalId\":\"6af1c0a12d6fb7b6ac6efd20\",\"optIn\":true,\"timestamp\":\"2026-11-08T14:20:01Z\",\"organisationRole\":\"data_source\",...}",
      "successorId": "6af1c0ab2d6fb7b6ac6efd27",
      "serializedHash": "a8138b18a0a66de72ddaa42be8a88bb45a22754d",
      "serializedSnapshot": "{\"schemaName\":\"DataDisclosureAgreementRecord\",\"objectId\":\"6af1c0a12d6fb7b6ac6efd20\",\"timestamp\":\"2026-11-08T14:20:01Z\",...}",
      "organisationId": "6ae2bf741c3dadfeb27982ec"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalItems": 2,
    "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-space:read

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
organisationRoleenum<string>required
Role of your organisation in the records to list: data_source (records of your own templates) or data_using_service (records of templates of other organisations that you signed).
Available options:data_source,data_using_service
dataDisclosureAgreementTemplateRevisionIdstring
Lists only the revisions of records that are based on this template revision.

Response

application/json

One page of record revisions.

revisionsobject[]
paginationobject