Skip to main content
GET
https://sandbox.getcollate.io/api
/
v1
/
dataProducts
GET /v1/dataProducts
from metadata.sdk import configure
from metadata.sdk.entities import DataProducts

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# List first page
products = DataProducts.list(limit=50)
for dp in products.data:
    print(f"{dp.fullyQualifiedName}")

# List all with auto-pagination
for dp in DataProducts.list_all():
    print(f"{dp.fullyQualifiedName}")

# Filter by domain with fields
products = DataProducts.list(
    domain="Marketing",
    fields=["owners", "domain", "experts", "assets"],
    limit=50
)

for dp in products.data:
    print(f"{dp.fullyQualifiedName}")
    if dp.owners:
        print(f"  Owners: {[o.name for o in dp.owners]}")
{
  "data": [
    {
      "id": "b1839f98-f046-5f35-bdef-20f9b3395cb2",
      "name": "CustomerInsights",
      "fullyQualifiedName": "Marketing.CustomerInsights",
      "displayName": "Customer Insights",
      "description": "Curated customer analytics data product",
      "version": 0.1,
      "updatedAt": 1769984330261,
      "updatedBy": "admin",
      "href": "http://localhost:8585/api/v1/dataProducts/b1839f98-f046-5f35-bdef-20f9b3395cb2",
      "domain": {
        "id": "a0729e98-e946-4e25-acde-10e8a2294ba1",
        "type": "domain",
        "name": "Marketing",
        "fullyQualifiedName": "Marketing",
        "deleted": false
      },
      "deleted": false,
      "owners": [],
      "experts": []
    }
  ],
  "paging": {
    "after": "...",
    "total": 3
  }
}

List Data Products

List all data products with optional filtering and pagination.

Query Parameters

domain
string
Filter by domain fully qualified name.
limit
integer
default:"10"
Maximum number of results to return (max: 1000000).
before
string
Cursor for backward pagination.
after
string
Cursor for forward pagination.
fields
string
Comma-separated list of fields to include: owners, domain, experts, assets. See Supported Fields below.
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/dataProducts
from metadata.sdk import configure
from metadata.sdk.entities import DataProducts

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# List first page
products = DataProducts.list(limit=50)
for dp in products.data:
    print(f"{dp.fullyQualifiedName}")

# List all with auto-pagination
for dp in DataProducts.list_all():
    print(f"{dp.fullyQualifiedName}")

# Filter by domain with fields
products = DataProducts.list(
    domain="Marketing",
    fields=["owners", "domain", "experts", "assets"],
    limit=50
)

for dp in products.data:
    print(f"{dp.fullyQualifiedName}")
    if dp.owners:
        print(f"  Owners: {[o.name for o in dp.owners]}")
{
  "data": [
    {
      "id": "b1839f98-f046-5f35-bdef-20f9b3395cb2",
      "name": "CustomerInsights",
      "fullyQualifiedName": "Marketing.CustomerInsights",
      "displayName": "Customer Insights",
      "description": "Curated customer analytics data product",
      "version": 0.1,
      "updatedAt": 1769984330261,
      "updatedBy": "admin",
      "href": "http://localhost:8585/api/v1/dataProducts/b1839f98-f046-5f35-bdef-20f9b3395cb2",
      "domain": {
        "id": "a0729e98-e946-4e25-acde-10e8a2294ba1",
        "type": "domain",
        "name": "Marketing",
        "fullyQualifiedName": "Marketing",
        "deleted": false
      },
      "deleted": false,
      "owners": [],
      "experts": []
    }
  ],
  "paging": {
    "after": "...",
    "total": 3
  }
}

Returns

Returns a paginated list of data product objects. By default, only basic fields are included. Use the fields parameter to request additional data.

Response

data
array
Array of data product objects.
paging
object
Pagination information.

Supported Fields

FieldDescription
ownersOwner references (users and teams)
domainParent domain reference
expertsSubject matter expert references
assetsAssociated data assets

Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to list data products