Skip to main content
Data Disclosure Agreements

List data disclosure agreement records

GET/v4/service/consent/data-disclosure-agreement/records

Lists the signed data disclosure agreement records of your organisation in one role. Your backend uses it to find the agreements that it can pull data under, or that give access to your data. It has the same parameters and answer as GET /v4/config/consent/data-disclosure-agreement/records.

Each record is in the state of its latest revision. A record is in the list only when its latest revision has the signatures of both parties: a record that only one party signed, or that the parties sign again, is not in the list. Use organisationRole=data_using_service for the agreements that you signed with data sources, and organisationRole=data_source for the records of your own templates. Filter on the opt-in state with signStatus.

Errors: 400 when organisationRole is missing or the pagination parameters are not valid.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:data-space-records: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

  • signStatusenum<string>

    sign lists only the opted-in records, unsign only the opted-out records. Leave it out to list both.

    Available options:sign,unsign

Response

application/json

One page of records.

  • dataDisclosureAgreementRecordsobject[]
  • paginationobject