List Domains

List all domains with optional filtering and pagination

GET /v1/domains

GET /v1/domains

Python

from metadata.sdk import configure
from metadata.sdk.entities import Domains

configure(
    host="https://your-company.open-metadata.org/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]}")

Response

{
  "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

Python

from metadata.sdk import configure
from metadata.sdk.entities import Domains

configure(
    host="https://your-company.open-metadata.org/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]}")

Response

{
  "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.

Show properties

id · string

Unique identifier for the domain (UUID format).

name · string

Domain name.

fullyQualifiedName · string

Fully qualified name of the domain.

domainType · string

Type of domain: Source-aligned, Consumer-aligned, or Aggregate.

owners · array

List of owners. Only included when fields contains owners.

children · array

Child domain references. Only included when fields contains children.

experts · array

Subject matter experts. Only included when fields contains experts.

paging · object

Pagination information.

Show properties

total · integer

Total count of domains matching the query.

after · string

Cursor for the next page of results. Null if this is the last page.

before · string

Cursor for the previous page of results. Null if this is the first page.

---

Supported Fields

The following fields can be requested via the fields query parameter:

Field	Description
owners	Owner references (users and teams)
children	Child domain references
experts	Subject matter expert references

---

Error Handling

Code	Error Type	Description
401	UNAUTHORIZED	Invalid or missing authentication token
403	FORBIDDEN	User lacks permission to list domains