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

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

# List first page
domains = Domains.list(limit=50)
for d in domains.data:
    print(f"{d.fullyQualifiedName} ({d.domainType})")

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

# With fields
domains = Domains.list(
    fields=["owners", "children", "experts"],
    limit=50
)

for d in domains.data:
    print(f"{d.fullyQualifiedName}")
    if d.owners:
        print(f"  Owners: {[o.name for o in d.owners]}")
{
  "data": [
    {
      "id": "a0729e98-e946-4e25-acde-10e8a2294ba1",
      "domainType": "Aggregate",
      "name": "TestDomain",
      "fullyQualifiedName": "TestDomain",
      "description": "Lorem ipsum...",
      "version": 0.1,
      "updatedAt": 1769984330261,
      "updatedBy": "admin",
      "href": "http://localhost:8585/api/v1/domains/a0729e98-e946-4e25-acde-10e8a2294ba1",
      "deleted": false,
      "owners": [],
      "children": []
    }
  ],
  "paging": {
    "after": "...",
    "total": 5
  }
}

List Domains

List all domains with optional filtering and pagination.

Query Parameters

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, children, experts. See Supported Fields below.
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/domains
from metadata.sdk import configure
from metadata.sdk.entities import Domains

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

# List first page
domains = Domains.list(limit=50)
for d in domains.data:
    print(f"{d.fullyQualifiedName} ({d.domainType})")

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

# With fields
domains = Domains.list(
    fields=["owners", "children", "experts"],
    limit=50
)

for d in domains.data:
    print(f"{d.fullyQualifiedName}")
    if d.owners:
        print(f"  Owners: {[o.name for o in d.owners]}")
{
  "data": [
    {
      "id": "a0729e98-e946-4e25-acde-10e8a2294ba1",
      "domainType": "Aggregate",
      "name": "TestDomain",
      "fullyQualifiedName": "TestDomain",
      "description": "Lorem ipsum...",
      "version": 0.1,
      "updatedAt": 1769984330261,
      "updatedBy": "admin",
      "href": "http://localhost:8585/api/v1/domains/a0729e98-e946-4e25-acde-10e8a2294ba1",
      "deleted": false,
      "owners": [],
      "children": []
    }
  ],
  "paging": {
    "after": "...",
    "total": 5
  }
}

Returns

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

Response

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

Supported Fields

The following fields can be requested via the fields query parameter:
FieldDescription
ownersOwner references (users and teams)
childrenChild domain references
expertsSubject matter expert references

Error Handling

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