Data Use Agreement

APIs for managing data use agreements

Search data use agreements

get

Search data use agreements in the marketplace using the provided filters

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

offsetnumberOptionalDefault: 0

limitnumber · min: 1OptionalDefault: 10

sortOrderstring · enumOptionalDefault: ascPossible values:

sortBystring · enumOptionalDefault: namePossible values:

nameFilterstringOptional

Filter results by data use agreement name

Default: ""

exactMatchbooleanOptional

Whether the filter should be an exact match

Default: false

Responses

200Success

application/json

get/api/data-use-agreement

GET /marketplace/api/data-use-agreement HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "body": "text",
      "createdBy": {
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedBy": {
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "updatedAt": "2026-01-01T00:00:00.000Z"
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 10,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}

Create data use agreement

post

Create a new data use agreement

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

idstring · uuidOptional

namestringRequired

The name of data use agreement

bodystringRequired

The contents of data use agreement

Responses

201Success

application/json

idstring · uuidRequired

namestringRequired

The name of data use agreement

bodystringRequired

The contents of data use agreement

createdAtone ofRequired

string · date-timeOptional

updatedAtone ofRequired

string · date-timeOptional

409

There is already a data use agreement with this name.

post/api/data-use-agreement

POST /marketplace/api/data-use-agreement HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "body": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "body": "text",
  "createdBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Get data use agreement by ID

get

Get data use agreement by ID

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200Success

application/json

idstring · uuidRequired

namestringRequired

The name of data use agreement

bodystringRequired

The contents of data use agreement

createdAtone ofRequired

string · date-timeOptional

updatedAtone ofRequired

string · date-timeOptional

get/api/data-use-agreement/{id}

GET /marketplace/api/data-use-agreement/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "body": "text",
  "createdBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Update data use agreement

put

Update a data use agreement

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

namestringOptional

The name of data use agreement

bodystringOptional

The contents of data use agreement

Responses

201Success

application/json

idstring · uuidRequired

namestringRequired

The name of data use agreement

bodystringRequired

The contents of data use agreement

createdAtone ofRequired

string · date-timeOptional

updatedAtone ofRequired

string · date-timeOptional

409

There is already a data use agreement with this name.

put/api/data-use-agreement/{id}

PUT /marketplace/api/data-use-agreement/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "name": "text",
  "body": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "body": "text",
  "createdBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Delete data use agreement

delete

Delete the specified data use agreement

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

204Success

No content

delete/api/data-use-agreement/{id}

DELETE /marketplace/api/data-use-agreement/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204Success

No content

Get request forms associated with a data use agreement

get

Get request forms associated with a data use agreement.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200Success

application/json

The request forms associated with the data use agreement

idstring · uuidRequired

namestringRequired

The name of the request form

get/api/data-use-agreement/{id}/request-forms

GET /marketplace/api/data-use-agreement/{id}/request-forms HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  }
]

PreviousRequest Form

NextHealth

Last updated 2 months ago

Was this helpful?