Book a demo

Marketplace API Endpoints

Private preview: The Marketplace app is available to select accounts. Contact your Immuta representative for details.

Search access requests

get

Search and filter access requests the current user can manage

Authorizations
Query parameters
dataProductIdstring · cuidOptional

The ID of the data product to filter requests by

searchTextstringOptional
userIdsstring[]Optional
historicalbooleanOptional

Whether to include historical access requests

Default: true
includeTemporarybooleanOptional

Whether to include temporary access requests

Default: false
offsetnumberOptionalDefault: 0
limitnumber · min: 1OptionalDefault: 10
sortOrderstring · enumOptionalDefault: descPossible values:
sortBystring · enumOptionalDefault: createdAtPossible values:
Responses
200Success
application/json
get
GET /marketplace/api/access-request HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "data": [
    {
      "id": "text",
      "requestingUser": {
        "id": 1,
        "iamId": "text",
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "name": "text",
        "email": "text"
      },
      "user": {
        "id": 1,
        "iamId": "text",
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "name": "text",
        "email": "text"
      },
      "formVersion": "text",
      "form": null,
      "status": "PENDING",
      "expiration": "2025-07-24T08:36:40.440Z",
      "createdAt": "2025-07-24T08:36:40.440Z",
      "updatedAt": "2025-07-24T08:36:40.440Z",
      "dataProduct": {
        "id": "text",
        "name": "text",
        "description": "All sales records from the current fiscal year"
      }
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 10,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}

Cancel a pending access request

delete

Cancel the specified pending access request by ID, cascading the cancellation to any pending and blocked approval records.

Authorizations
Path parameters
idstringRequired
Responses
204Success
delete
DELETE /marketplace/api/access-request/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
204Success
No content

Get individual access request

get

Returns specific details for a specific access request

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /marketplace/api/access-request/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "id": "text",
  "requestingUser": {
    "id": 1,
    "iamId": "text",
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "username": "text",
    "name": "text",
    "email": "text"
  },
  "user": {
    "id": 1,
    "iamId": "text",
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "username": "text",
    "name": "text",
    "email": "text"
  },
  "formVersion": "text",
  "form": null,
  "status": "PENDING",
  "expiration": "2025-07-24T08:36:40.440Z",
  "createdAt": "2025-07-24T08:36:40.440Z",
  "updatedAt": "2025-07-24T08:36:40.440Z",
  "dataProduct": {
    "id": "text",
    "name": "text",
    "description": "All sales records from the current fiscal year"
  }
}

Get approval records associated with the a request

get

Returns all approval records associated with a specific access request

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /marketplace/api/access-request/{id}/records HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "approvalRecords": [
    {
      "id": "text",
      "dataAccessRequestId": "text",
      "approvers": [
        {
          "type": "USER",
          "id": "text",
          "displayName": "text"
        }
      ],
      "prerequisites": [
        "text"
      ],
      "actionBy": {
        "id": 1,
        "iamId": "text",
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "name": "text",
        "email": "text"
      },
      "status": "PENDING",
      "reason": "text",
      "createdAt": "2025-07-24T08:36:40.440Z",
      "updatedAt": "2025-07-24T08:36:40.440Z"
    }
  ]
}

Get the risk assessment for a specific access request

get

Returns the risk assessment for a specific access request

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
Responseone of
or
get
GET /marketplace/api/access-request/{id}/risk-assessment HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "conflictDetected": true,
  "approvalRisk": "HIGH",
  "recommendation": "APPROVED",
  "nAllowed": 1,
  "nDenied": 1,
  "riskValue": 1,
  "cohort": {
    "literals": [
      {
        "name": "text"
      },
      {
        "negation": true
      }
    ]
  },
  "medianApprovalTimeWindowInDays": 1,
  "explanation": "text",
  "approvalReasons": [
    "text"
  ],
  "denialReasons": [
    "text"
  ]
}

Approve or reject an approval record

put

Modify a pending approval record as an approver

Authorizations
Path parameters
idstringRequired
Body
statusstring · enumRequiredExample: PENDINGPossible values:
reasonstringOptional
durationnumber · min: 1Optional
durationUnitstring · enumOptionalPossible values:
Responses
200Success
application/json
put
PUT /marketplace/api/approval-record/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "status": "PENDING",
  "reason": "text",
  "duration": 1,
  "durationUnit": "HOURS"
}
200Success
{
  "id": "text",
  "dataAccessRequestId": "text",
  "approvers": [
    {
      "type": "USER",
      "id": "text",
      "displayName": "text"
    }
  ],
  "prerequisites": [
    "text"
  ],
  "actionBy": {
    "id": 1,
    "iamId": "text",
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "username": "text",
    "name": "text",
    "email": "text"
  },
  "status": "PENDING",
  "reason": "text",
  "createdAt": "2025-07-24T08:36:40.440Z",
  "updatedAt": "2025-07-24T08:36:40.440Z"
}

Search data products across the marketplace

get

Search data products in the marketplace using the provided filters

Authorizations
Query parameters
nextTokenstringOptional

Pagination token to fetch the next page of results

limitnumber · min: 1 · max: 100Optional

The number of items to return per page

Default: 10
sortOrderstring · enumOptionalDefault: ascPossible values:
sortBystring · enumOptionalPossible values:
nameFilterstringOptional
Responses
200Success
application/json
get
GET /marketplace/api/data-product HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "data": [
    {
      "id": "text",
      "name": "text",
      "description": "All sales records from the current fiscal year",
      "domains": [
        "4d004a3a-4568-4c1d-822e-30958ef898dc"
      ],
      "suspended": false,
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-07-24T08:36:40.440Z",
      "updatedAt": "2025-07-24T08:36:40.440Z",
      "status": "PENDING",
      "expiration": "2025-07-24T08:36:40.440Z",
      "stats": {
        "dataSourceCount": 1,
        "pendingRequestCount": 1,
        "approvedRequestCount": 1,
        "revokedRequestCount": 1,
        "canceledRequestCount": 1,
        "deniedRequestCount": 1,
        "totalRequestCount": 1
      },
      "requestId": "text",
      "sourceTypes": [
        "Databricks",
        "Redshift",
        "Snowflake"
      ],
      "metadata": {
        "subjectMatterExpert": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "username": "text"
        }
      }
    }
  ],
  "meta": {
    "nextToken": "text",
    "limit": 10
  }
}

Add new data products to the marketplace

post

Add one or more data products to the marketplace

Authorizations
Body
namestring · min: 1 · max: 64Required

Data product name

Pattern: ^[a-zA-Z0-9)(\-_/\\\s]*$
descriptionone of | nullableOptional

Data product description

stringOptional

Data product description

Example: All sales records from the current fiscal year
domainsstring[]RequiredExample: ["4d004a3a-4568-4c1d-822e-30958ef898dc"]
statusstring · enumOptionalExample: PENDINGPossible values:
expirationone of | nullableOptional
string · date-timeOptional
sourceTypesstring[]Optional

The types of data sources contained in the data product.

Example: ["Databricks","Redshift","Snowflake"]
idstring · uuidOptional

Data product ID

metadataone of | nullableRequired
requestFormIdone ofRequired
string · cuidOptional
or
string · uuidOptional
Responses
201Success
application/json
post
POST /marketplace/api/data-product HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 597

{
  "name": "text",
  "description": "All sales records from the current fiscal year",
  "domains": [
    "4d004a3a-4568-4c1d-822e-30958ef898dc"
  ],
  "status": "PENDING",
  "expiration": "2025-07-24T08:36:40.440Z",
  "stats": {
    "dataSourceCount": 1,
    "pendingRequestCount": 1,
    "approvedRequestCount": 1,
    "revokedRequestCount": 1,
    "canceledRequestCount": 1,
    "deniedRequestCount": 1,
    "totalRequestCount": 1
  },
  "sourceTypes": [
    "Databricks",
    "Redshift",
    "Snowflake"
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "dataSources": [
    {
      "sourceId": "text"
    }
  ],
  "metadata": {
    "subjectMatterExpert": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  },
  "requestFormId": "text"
}
{
  "id": "text",
  "name": "text",
  "description": "All sales records from the current fiscal year",
  "domains": [
    "4d004a3a-4568-4c1d-822e-30958ef898dc"
  ],
  "suspended": false,
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-07-24T08:36:40.440Z",
  "updatedAt": "2025-07-24T08:36:40.440Z",
  "status": "PENDING",
  "expiration": "2025-07-24T08:36:40.440Z",
  "stats": {
    "dataSourceCount": 1,
    "pendingRequestCount": 1,
    "approvedRequestCount": 1,
    "revokedRequestCount": 1,
    "canceledRequestCount": 1,
    "deniedRequestCount": 1,
    "totalRequestCount": 1
  },
  "requestId": "text",
  "sourceTypes": [
    "Databricks",
    "Redshift",
    "Snowflake"
  ],
  "metadata": {
    "subjectMatterExpert": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "username": "text"
    }
  }
}

Delete data product by ID

delete

Delete the specified data product from the system

Authorizations
Path parameters
idstringRequired
Responses
200Success
delete
DELETE /marketplace/api/data-product/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
No content

Get data product by ID

get

Get data product metadata for the specified data product ID

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /marketplace/api/data-product/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "id": "text",
  "name": "text",
  "description": "All sales records from the current fiscal year",
  "domains": [
    "4d004a3a-4568-4c1d-822e-30958ef898dc"
  ],
  "suspended": false,
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-07-24T08:36:40.440Z",
  "updatedAt": "2025-07-24T08:36:40.440Z",
  "status": "PENDING",
  "expiration": "2025-07-24T08:36:40.440Z",
  "stats": {
    "dataSourceCount": 1,
    "pendingRequestCount": 1,
    "approvedRequestCount": 1,
    "revokedRequestCount": 1,
    "canceledRequestCount": 1,
    "deniedRequestCount": 1,
    "totalRequestCount": 1
  },
  "requestId": "text",
  "sourceTypes": [
    "Databricks",
    "Redshift",
    "Snowflake"
  ],
  "metadata": {
    "subjectMatterExpert": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "username": "text"
    }
  }
}

Update an existing data product

put

Update an existing data product by ID

Authorizations
Path parameters
idstringRequired
Body
namestring · min: 1 · max: 64Optional

Data product name

Pattern: ^[a-zA-Z0-9)(\-_/\\\s]*$
descriptionone of | nullableOptional

Data product description

stringOptional

Data product description

Example: All sales records from the current fiscal year
domainsstring[]OptionalExample: ["4d004a3a-4568-4c1d-822e-30958ef898dc"]
statusstring · enumOptionalExample: PENDINGPossible values:
expirationone of | nullableOptional
string · date-timeOptional
sourceTypesstring[]Optional

The types of data sources contained in the data product.

Example: ["Databricks","Redshift","Snowflake"]
idstring · uuidOptional

Data product ID

metadataone of | nullableOptional
requestFormIdone ofOptional
string · cuidOptional
or
string · uuidOptional
suspendedbooleanOptional

Whether access to the data product's data sources is suspended

Example: false
Responses
200Success
application/json
put
PUT /marketplace/api/data-product/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 615

{
  "name": "text",
  "description": "All sales records from the current fiscal year",
  "domains": [
    "4d004a3a-4568-4c1d-822e-30958ef898dc"
  ],
  "status": "PENDING",
  "expiration": "2025-07-24T08:36:40.440Z",
  "stats": {
    "dataSourceCount": 1,
    "pendingRequestCount": 1,
    "approvedRequestCount": 1,
    "revokedRequestCount": 1,
    "canceledRequestCount": 1,
    "deniedRequestCount": 1,
    "totalRequestCount": 1
  },
  "sourceTypes": [
    "Databricks",
    "Redshift",
    "Snowflake"
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "dataSources": [
    {
      "sourceId": "text"
    }
  ],
  "metadata": {
    "subjectMatterExpert": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  },
  "requestFormId": "text",
  "suspended": false
}
200Success
{
  "id": "text",
  "name": "text",
  "description": "All sales records from the current fiscal year",
  "domains": [
    "4d004a3a-4568-4c1d-822e-30958ef898dc"
  ],
  "suspended": false,
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-07-24T08:36:40.440Z",
  "updatedAt": "2025-07-24T08:36:40.440Z",
  "status": "PENDING",
  "expiration": "2025-07-24T08:36:40.440Z",
  "stats": {
    "dataSourceCount": 1,
    "pendingRequestCount": 1,
    "approvedRequestCount": 1,
    "revokedRequestCount": 1,
    "canceledRequestCount": 1,
    "deniedRequestCount": 1,
    "totalRequestCount": 1
  },
  "requestId": "text",
  "sourceTypes": [
    "Databricks",
    "Redshift",
    "Snowflake"
  ],
  "metadata": {
    "subjectMatterExpert": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "username": "text"
    }
  }
}

Search all data sources in the data product

get

Search all data sources for the data product using the provided filters

Authorizations
Path parameters
idstringRequired
Query parameters
nextTokenstringOptional

Pagination token to fetch the next page of results

limitnumber · min: 1 · max: 100Optional

The number of items to return per page

Default: 10
userstring · uuidOptional

The global user ID to search data source access status for

Responses
200Success
application/json
get
GET /marketplace/api/data-product/{id}/datasources HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "data": [
    {
      "id": "text",
      "name": "Web Sales 2024",
      "type": "text",
      "sourceId": "text",
      "hostname": "text",
      "database": "text",
      "schema": "text",
      "table": "text",
      "prefix": "text",
      "status": "NONE"
    }
  ],
  "meta": {
    "nextToken": "text",
    "limit": 10
  }
}

Update the data product's data sources

put

Update the data sources associated with the data product. Any currently associated data sources not included in the payload will be removed.

Authorizations
Path parameters
idstringRequired
Body
Responses
200Success
application/json
put
PUT /marketplace/api/data-product/{id}/datasources HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "dataSources": [
    {
      "sourceId": "text"
    }
  ]
}
200Success
{
  "id": "text",
  "name": "text",
  "description": "All sales records from the current fiscal year",
  "domains": [
    "4d004a3a-4568-4c1d-822e-30958ef898dc"
  ],
  "suspended": false,
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-07-24T08:36:40.440Z",
  "updatedAt": "2025-07-24T08:36:40.440Z",
  "status": "PENDING",
  "expiration": "2025-07-24T08:36:40.440Z",
  "stats": {
    "dataSourceCount": 1,
    "pendingRequestCount": 1,
    "approvedRequestCount": 1,
    "revokedRequestCount": 1,
    "canceledRequestCount": 1,
    "deniedRequestCount": 1,
    "totalRequestCount": 1
  },
  "requestId": "text",
  "sourceTypes": [
    "Databricks",
    "Redshift",
    "Snowflake"
  ],
  "metadata": {
    "subjectMatterExpert": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "username": "text"
    }
  }
}

Get all data sources in the data product

get

Get all data sources in the data product

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /marketplace/api/data-product/{id}/datasources/all HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "dataSources": [
    {
      "sourceId": "text"
    }
  ]
}

Search all access requests for the data product

get

Search all access requests for the data product using the provided filters

Authorizations
Path parameters
idstringRequired
Query parameters
searchTextstringOptional
userIdsstring[]Optional
historicalbooleanOptional

Whether to include historical access requests

Default: true
includeTemporarybooleanOptional

Whether to include temporary access requests

Default: false
offsetnumberOptionalDefault: 0
limitnumber · min: 1OptionalDefault: 10
sortOrderstring · enumOptionalDefault: descPossible values:
sortBystring · enumOptionalDefault: createdAtPossible values:
Responses
200Success
application/json
get
GET /marketplace/api/data-product/{id}/request HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "data": [
    {
      "id": "text",
      "requestingUser": {
        "id": 1,
        "iamId": "text",
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "name": "text",
        "email": "text"
      },
      "user": {
        "id": 1,
        "iamId": "text",
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "name": "text",
        "email": "text"
      },
      "formVersion": "text",
      "form": null,
      "status": "PENDING",
      "expiration": "2025-07-24T08:36:40.440Z",
      "createdAt": "2025-07-24T08:36:40.440Z",
      "updatedAt": "2025-07-24T08:36:40.440Z",
      "dataProduct": {
        "id": "text",
        "name": "text",
        "description": "All sales records from the current fiscal year"
      }
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 10,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}

Request access to a data product

post

Create a new data access request for the specified data product

Authorizations
Path parameters
idstringRequired
Body
userstring · uuidRequired

Immuta global user ID of the user for whom access is being requested

formanyOptional

The request form submission

Responses
201Success
application/json
post
POST /marketplace/api/data-product/{id}/request HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "user": "123e4567-e89b-12d3-a456-426614174000",
  "form": null
}
201Success
{
  "id": "text",
  "requestingUser": {
    "id": 1,
    "iamId": "text",
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "username": "text",
    "name": "text",
    "email": "text"
  },
  "user": {
    "id": 1,
    "iamId": "text",
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "username": "text",
    "name": "text",
    "email": "text"
  },
  "formVersion": "text",
  "form": null,
  "status": "PENDING",
  "expiration": "2025-07-24T08:36:40.440Z",
  "createdAt": "2025-07-24T08:36:40.440Z",
  "updatedAt": "2025-07-24T08:36:40.440Z",
  "dataProduct": {
    "id": "text",
    "name": "text",
    "description": "All sales records from the current fiscal year"
  }
}

Revoke access to a data product

delete

Updates the specified access request to revoked and revokes access to data sources associated with the data product

Authorizations
Path parameters
idstringRequired
requestIdstringRequired
Responses
204Success
delete
DELETE /marketplace/api/data-product/{id}/request/{requestId} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
204Success
No content

Returns 5 most recent manual access determinations

get

Returns 5 most recent data access requests with a terminal status as well as the approval records which contributed to that status.

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /marketplace/api/data-product/{id}/recent-determinations HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "determinations": [
    {
      "id": "text",
      "requestingUser": {
        "id": 1,
        "iamId": "text",
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "name": "text",
        "email": "text"
      },
      "user": {
        "id": 1,
        "iamId": "text",
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "name": "text",
        "email": "text"
      },
      "actionBy": {
        "id": 1,
        "iamId": "text",
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "name": "text",
        "email": "text"
      },
      "reason": "text",
      "status": "PENDING",
      "createdAt": "2025-07-24T08:36:40.440Z",
      "updatedAt": "2025-07-24T08:36:40.440Z",
      "expiration": "2025-07-24T08:36:40.440Z"
    }
  ]
}

Get data product by name

get

Get data product metadata for the specified data product name

Authorizations
Path parameters
namestringRequired
Responses
200Success
application/json
get
GET /marketplace/api/data-product/{name}/byName HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "id": "text",
  "name": "text",
  "description": "All sales records from the current fiscal year",
  "domains": [
    "4d004a3a-4568-4c1d-822e-30958ef898dc"
  ],
  "suspended": false,
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-07-24T08:36:40.440Z",
  "updatedAt": "2025-07-24T08:36:40.440Z",
  "status": "PENDING",
  "expiration": "2025-07-24T08:36:40.440Z",
  "stats": {
    "dataSourceCount": 1,
    "pendingRequestCount": 1,
    "approvedRequestCount": 1,
    "revokedRequestCount": 1,
    "canceledRequestCount": 1,
    "deniedRequestCount": 1,
    "totalRequestCount": 1
  },
  "requestId": "text",
  "sourceTypes": [
    "Databricks",
    "Redshift",
    "Snowflake"
  ],
  "metadata": {
    "subjectMatterExpert": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "username": "text"
    }
  }
}

Get all data use agreements

get

Search data use agreements in the Marketplace using the provided filters

Authorizations
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
GET /marketplace/api/data-use-agreement HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "body": "text",
      "createdBy": {
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "createdAt": "2025-07-24T08:36:40.440Z",
      "updatedBy": {
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "updatedAt": "2025-07-24T08:36:40.440Z"
    }
  ],
  "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
Body
idstring · uuidOptional
namestringRequired

The name of data use agreement

bodystringRequired

The contents of data use agreement

Responses
201Success
application/json
post
POST /marketplace/api/data-use-agreement HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
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": "2025-07-24T08:36:40.440Z",
  "updatedBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "updatedAt": "2025-07-24T08:36:40.440Z"
}

Delete data use agreement

delete

Delete the specified data use agreement

Authorizations
Path parameters
idstringRequired
Responses
204Success
delete
DELETE /marketplace/api/data-use-agreement/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
204Success
No content

Get data use agreement by ID

get

Get data use agreement by ID

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /marketplace/api/data-use-agreement/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "body": "text",
  "createdBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "createdAt": "2025-07-24T08:36:40.440Z",
  "updatedBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "updatedAt": "2025-07-24T08:36:40.440Z"
}

Update data use agreement

put

Update a data use agreement

Authorizations
Path parameters
idstringRequired
Body
namestringOptional

The name of data use agreement

bodystringOptional

The contents of data use agreement

Responses
201Success
application/json
put
PUT /marketplace/api/data-use-agreement/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
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": "2025-07-24T08:36:40.440Z",
  "updatedBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "updatedAt": "2025-07-24T08:36:40.440Z"
}

Get request forms associated with a data use agreement

get

Get request forms associated with a data use agreement.

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /marketplace/api/data-use-agreement/{id}/request-forms HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  }
]

Search Immuta attributes

get

Search across all attributes in Immuta

Authorizations
Query parameters
searchstringOptional
typestringOptional
Responses
200Success
application/json
get
GET /marketplace/api/metadata/attributes HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "attributes": [
    {
      "type": "text",
      "value": "text"
    }
  ]
}

Get columns for a data source with masking info

get

Returns all columns for the specified data source, including masking policy information (local/global).

Authorizations
Path parameters
idnumberRequired
Responses
200Success
application/json
get
GET /marketplace/api/metadata/datasource/{id}/columns HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
[
  {
    "name": "text",
    "tags": [
      "text"
    ],
    "masking": [
      {
        "type": "text",
        "global": true
      }
    ]
  }
]

Get available Immuta domains

get

Search Immuta domains that can be used to create a data product in the marketplace

Authorizations
Responses
200Success
application/json
get
GET /marketplace/api/metadata/domain HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "domains": [
    {
      "id": "text",
      "name": "North American Sales",
      "description": "A collection of data sources relevant to North American sales"
    }
  ]
}

Get the specified domain

get

Returns the Immuta domain specified in the request

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /marketplace/api/metadata/domain/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "id": "text",
  "name": "North American Sales",
  "description": "A collection of data sources relevant to North American sales"
}

Search data sources in domain

get

Search data sources within the selected domain that can be included in a data product

Authorizations
Path parameters
idstringRequired
Query parameters
offsetnumberOptionalDefault: 0
limitnumber · min: 1OptionalDefault: 10
searchTextstringOptional

Search text to filter data sources

dataSourceIdsnumber[]Optional

Array of ids to filter data sources

Responses
200Success
application/json
get
GET /marketplace/api/metadata/domain/{id}/datasources HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "data": [
    {
      "dataSourceId": 1,
      "name": "November 2023 Online",
      "platform": "Databricks",
      "createdAt": "2025-07-24T08:36:40.440Z",
      "prefix": "text",
      "hostname": "text",
      "database": "text",
      "schema": "text",
      "table": "text"
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 10,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}

Search Immuta groups

get

Search across all groups in Immuta

Authorizations
Query parameters
limitnumberOptionalDefault: 100
filterstringOptional
Responses
200Success
application/json
get
GET /marketplace/api/metadata/groups HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "groups": [
    {
      "id": 1,
      "iamId": "text",
      "name": "text",
      "email": "[email protected]"
    }
  ]
}

Search Immuta users

get

Search across all users in Immuta

Authorizations
Query parameters
limitnumberOptionalDefault: 100
filterstringOptional
globalUserIdstring[]Optional
Responses
200Success
application/json
get
GET /marketplace/api/metadata/users HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "users": [
    {
      "id": 1,
      "iamId": "text",
      "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
      "username": "text",
      "name": "text",
      "email": "text"
    }
  ]
}

Get all request forms

get

Search request forms in the marketplace using the provided filters

Authorizations
Query parameters
offsetnumberOptionalDefault: 0
limitnumber · min: 1OptionalDefault: 10
sortOrderstring · enumOptionalDefault: ascPossible values:
sortBystring · enumOptionalDefault: namePossible values:
nameFilterstringOptional

Filter results by request form name

Default: ""
exactMatchbooleanOptional

Whether the filter should be an exact match

Default: false
Responses
200Success
application/json
get
GET /marketplace/api/request-form HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "fields": [
        {
          "id": "35f1fd8c-8fd6-4a82-89af-e9a870f45d76",
          "type": "DROPDOWN",
          "label": "text",
          "required": true,
          "options": [
            {
              "value": "text"
            }
          ]
        }
      ],
      "policy": {
        "version": "text",
        "rules": [
          {
            "conditions": {
              "all": []
            },
            "event": {
              "type": "approve",
              "params": {
                "comment": "text",
                "duration": 1,
                "durationUnit": "HOURS"
              }
            }
          }
        ],
        "defaultEvent": {
          "type": "approve",
          "params": {
            "comment": "text",
            "duration": 1,
            "durationUnit": "HOURS"
          }
        }
      },
      "dataUseAgreements": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "body": "text"
        }
      ],
      "createdBy": {
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "createdAt": "2025-07-24T08:36:40.440Z",
      "updatedBy": {
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "updatedAt": "2025-07-24T08:36:40.440Z",
      "version": "text",
      "associatedDomains": [
        "4d004a3a-4568-4c1d-822e-30958ef898dc"
      ]
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 10,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}

Create request form

post

Create a request form

Authorizations
Body
idstring · uuidOptional
namestringRequired
dataUseAgreementIdsstring · uuid[]Optional
Responses
201Success
application/json
post
POST /marketplace/api/request-form HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 510

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "fields": [
    {
      "id": "31e45b8b-5623-4844-be63-d20a9edceda7",
      "type": "DROPDOWN",
      "label": "text",
      "required": true,
      "options": [
        {
          "value": "text"
        }
      ]
    }
  ],
  "policy": {
    "version": "text",
    "rules": [
      {
        "conditions": {
          "all": []
        },
        "event": {
          "type": "approve",
          "params": {
            "comment": "text",
            "duration": 1,
            "durationUnit": "HOURS"
          }
        }
      }
    ],
    "defaultEvent": {
      "type": "approve",
      "params": {
        "comment": "text",
        "duration": 1,
        "durationUnit": "HOURS"
      }
    }
  },
  "dataUseAgreementIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "fields": [
    {
      "id": "020fa6c7-763c-495e-838b-0092e90f1af5",
      "type": "DROPDOWN",
      "label": "text",
      "required": true,
      "options": [
        {
          "value": "text"
        }
      ]
    }
  ],
  "policy": {
    "version": "text",
    "rules": [
      {
        "conditions": {
          "all": []
        },
        "event": {
          "type": "approve",
          "params": {
            "comment": "text",
            "duration": 1,
            "durationUnit": "HOURS"
          }
        }
      }
    ],
    "defaultEvent": {
      "type": "approve",
      "params": {
        "comment": "text",
        "duration": 1,
        "durationUnit": "HOURS"
      }
    }
  },
  "dataUseAgreements": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "body": "text"
    }
  ],
  "createdBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "createdAt": "2025-07-24T08:36:40.440Z",
  "updatedBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "updatedAt": "2025-07-24T08:36:40.440Z",
  "version": "text"
}

Delete a request form

delete

Delete a request form

Authorizations
Path parameters
idstringRequired
Responses
204Success
delete
DELETE /marketplace/api/request-form/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
204Success
No content

Get request form by ID

get

Get request form by ID

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /marketplace/api/request-form/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "fields": [
    {
      "id": "020fa6c7-763c-495e-838b-0092e90f1af5",
      "type": "DROPDOWN",
      "label": "text",
      "required": true,
      "options": [
        {
          "value": "text"
        }
      ]
    }
  ],
  "policy": {
    "version": "text",
    "rules": [
      {
        "conditions": {
          "all": []
        },
        "event": {
          "type": "approve",
          "params": {
            "comment": "text",
            "duration": 1,
            "durationUnit": "HOURS"
          }
        }
      }
    ],
    "defaultEvent": {
      "type": "approve",
      "params": {
        "comment": "text",
        "duration": 1,
        "durationUnit": "HOURS"
      }
    }
  },
  "dataUseAgreements": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "body": "text"
    }
  ],
  "createdBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "createdAt": "2025-07-24T08:36:40.440Z",
  "updatedBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "updatedAt": "2025-07-24T08:36:40.440Z",
  "version": "text"
}

Update a request form

put

Update a request form

Authorizations
Path parameters
idstringRequired
Body
idstring · uuidOptional
namestringOptional
dataUseAgreementIdsstring · uuid[]Optional
Responses
201Success
application/json
put
PUT /marketplace/api/request-form/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 510

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "fields": [
    {
      "id": "ec493191-7d4c-495e-a734-2ac2df369983",
      "type": "DROPDOWN",
      "label": "text",
      "required": true,
      "options": [
        {
          "value": "text"
        }
      ]
    }
  ],
  "policy": {
    "version": "text",
    "rules": [
      {
        "conditions": {
          "all": []
        },
        "event": {
          "type": "approve",
          "params": {
            "comment": "text",
            "duration": 1,
            "durationUnit": "HOURS"
          }
        }
      }
    ],
    "defaultEvent": {
      "type": "approve",
      "params": {
        "comment": "text",
        "duration": 1,
        "durationUnit": "HOURS"
      }
    }
  },
  "dataUseAgreementIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
201Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "fields": [
    {
      "id": "020fa6c7-763c-495e-838b-0092e90f1af5",
      "type": "DROPDOWN",
      "label": "text",
      "required": true,
      "options": [
        {
          "value": "text"
        }
      ]
    }
  ],
  "policy": {
    "version": "text",
    "rules": [
      {
        "conditions": {
          "all": []
        },
        "event": {
          "type": "approve",
          "params": {
            "comment": "text",
            "duration": 1,
            "durationUnit": "HOURS"
          }
        }
      }
    ],
    "defaultEvent": {
      "type": "approve",
      "params": {
        "comment": "text",
        "duration": 1,
        "durationUnit": "HOURS"
      }
    }
  },
  "dataUseAgreements": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "body": "text"
    }
  ],
  "createdBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "createdAt": "2025-07-24T08:36:40.440Z",
  "updatedBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "updatedAt": "2025-07-24T08:36:40.440Z",
  "version": "text"
}

Get data products by request form

get

Get the data products assigned to the request form

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /marketplace/api/request-form/{id}/data-products HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
[
  {
    "id": "text",
    "name": "text"
  }
]

Get request form by version

get

Get request form by its version

Authorizations
Path parameters
versionstringRequired
Responses
200Success
application/json
get
GET /marketplace/api/request-form/version/{version} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "fields": [
    {
      "id": "020fa6c7-763c-495e-838b-0092e90f1af5",
      "type": "DROPDOWN",
      "label": "text",
      "required": true,
      "options": [
        {
          "value": "text"
        }
      ]
    }
  ],
  "policy": {
    "version": "text",
    "rules": [
      {
        "conditions": {
          "all": []
        },
        "event": {
          "type": "approve",
          "params": {
            "comment": "text",
            "duration": 1,
            "durationUnit": "HOURS"
          }
        }
      }
    ],
    "defaultEvent": {
      "type": "approve",
      "params": {
        "comment": "text",
        "duration": 1,
        "durationUnit": "HOURS"
      }
    }
  },
  "dataUseAgreements": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "body": "text"
    }
  ],
  "createdBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "createdAt": "2025-07-24T08:36:40.440Z",
  "updatedBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "updatedAt": "2025-07-24T08:36:40.440Z",
  "version": "text"
}

Frontend settings

get

Get the settings for the frontend marketplace application.

Responses
200Success
application/json
get
GET /marketplace/api/settings/frontend HTTP/1.1
Host: na.api.immutacloud.com
Accept: */*
200Success
{
  "theme": {
    "primaryColor": "text",
    "accentColor": "text",
    "lightModeImage": "text",
    "darkModeImage": "text"
  },
  "featureFlags": {
    "launchDarklyClientKey": "text",
    "launchDarklyClientHash": "text",
    "launchDarklyBaseUri": "text",
    "statsigClientKey": "text",
    "statsigEnvironment": "text"
  }
}
PreviousMarketplace APINextSource Controlling Data Products

Last updated

Was this helpful?