GET /v1/domains/{id}

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

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

# Get by ID
domain = Domains.retrieve("a0729e98-e946-4e25-acde-10e8a2294ba1")
print(f"{domain.fullyQualifiedName}: {domain.domainType}")

# Get by ID with fields
domain = Domains.retrieve(
    "a0729e98-e946-4e25-acde-10e8a2294ba1",
    fields=["owners", "children", "experts"]
)

# Get by fully qualified name
domain = Domains.retrieve_by_name("TestDomain")

# Get by name with fields
domain = Domains.retrieve_by_name(
    "TestDomain",
    fields=["owners", "children", "experts"]
)

import static org.openmetadata.sdk.fluent.Domains.*;

// Get by ID
var domain = Domains.retrieve("a0729e98-e946-4e25-acde-10e8a2294ba1");

// Get by ID with fields
var domain = Domains.retrieve(
    "a0729e98-e946-4e25-acde-10e8a2294ba1",
    "owners,children,experts"
);

// Get by fully qualified name
var domain = Domains.retrieveByName("TestDomain");

// Get by name with fields
var domain = Domains.retrieveByName("TestDomain", "owners,children,experts");

# Get by ID
curl "{base_url}/api/v1/domains/a0729e98-e946-4e25-acde-10e8a2294ba1" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/domains/a0729e98-e946-4e25-acde-10e8a2294ba1?fields=owners,children,experts" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/domains/name/TestDomain" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/domains/name/TestDomain?fields=owners,children,experts" \
  -H "Authorization: Bearer {access_token}"

{
  "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": []
}

GET

domains

{id}

GET /v1/domains/{id}

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

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

# Get by ID
domain = Domains.retrieve("a0729e98-e946-4e25-acde-10e8a2294ba1")
print(f"{domain.fullyQualifiedName}: {domain.domainType}")

# Get by ID with fields
domain = Domains.retrieve(
    "a0729e98-e946-4e25-acde-10e8a2294ba1",
    fields=["owners", "children", "experts"]
)

# Get by fully qualified name
domain = Domains.retrieve_by_name("TestDomain")

# Get by name with fields
domain = Domains.retrieve_by_name(
    "TestDomain",
    fields=["owners", "children", "experts"]
)

import static org.openmetadata.sdk.fluent.Domains.*;

// Get by ID
var domain = Domains.retrieve("a0729e98-e946-4e25-acde-10e8a2294ba1");

// Get by ID with fields
var domain = Domains.retrieve(
    "a0729e98-e946-4e25-acde-10e8a2294ba1",
    "owners,children,experts"
);

// Get by fully qualified name
var domain = Domains.retrieveByName("TestDomain");

// Get by name with fields
var domain = Domains.retrieveByName("TestDomain", "owners,children,experts");

# Get by ID
curl "{base_url}/api/v1/domains/a0729e98-e946-4e25-acde-10e8a2294ba1" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/domains/a0729e98-e946-4e25-acde-10e8a2294ba1?fields=owners,children,experts" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/domains/name/TestDomain" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/domains/name/TestDomain?fields=owners,children,experts" \
  -H "Authorization: Bearer {access_token}"

{
  "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": []
}

Retrieve a Domain

Get a single domain by its unique ID or fully qualified name.

Get by ID

string

required

UUID of the domain to retrieve.

string

Comma-separated list of fields to include (e.g., owners,children,experts).

string

default:"non-deleted"

Include all, deleted, or non-deleted entities.

Get by Fully Qualified Name

Use GET /v1/domains/name/{fqn} to retrieve by fully qualified name.

string

required

Fully qualified name of the domain (e.g., TestDomain or Engineering.DataPlatform).

string

Comma-separated list of fields to include: owners, children, experts.

string

default:"non-deleted"

Include all, deleted, or non-deleted entities.

GET /v1/domains/{id}

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

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

# Get by ID
domain = Domains.retrieve("a0729e98-e946-4e25-acde-10e8a2294ba1")
print(f"{domain.fullyQualifiedName}: {domain.domainType}")

# Get by ID with fields
domain = Domains.retrieve(
    "a0729e98-e946-4e25-acde-10e8a2294ba1",
    fields=["owners", "children", "experts"]
)

# Get by fully qualified name
domain = Domains.retrieve_by_name("TestDomain")

# Get by name with fields
domain = Domains.retrieve_by_name(
    "TestDomain",
    fields=["owners", "children", "experts"]
)

import static org.openmetadata.sdk.fluent.Domains.*;

// Get by ID
var domain = Domains.retrieve("a0729e98-e946-4e25-acde-10e8a2294ba1");

// Get by ID with fields
var domain = Domains.retrieve(
    "a0729e98-e946-4e25-acde-10e8a2294ba1",
    "owners,children,experts"
);

// Get by fully qualified name
var domain = Domains.retrieveByName("TestDomain");

// Get by name with fields
var domain = Domains.retrieveByName("TestDomain", "owners,children,experts");

# Get by ID
curl "{base_url}/api/v1/domains/a0729e98-e946-4e25-acde-10e8a2294ba1" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/domains/a0729e98-e946-4e25-acde-10e8a2294ba1?fields=owners,children,experts" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/domains/name/TestDomain" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/domains/name/TestDomain?fields=owners,children,experts" \
  -H "Authorization: Bearer {access_token}"

{
  "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": []
}

Returns

Returns a domain object with all requested fields populated.

Response

string

Unique identifier for the domain (UUID format).

string

Domain name.

string

Fully qualified name of the domain.

string

Human-readable display name.

string

Description of the domain in Markdown format.

string

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

array

List of owners. Only included when fields contains owners.

array

Child domain references. Only included when fields contains children.

array

Subject matter experts. Only included when fields contains experts.

number

Version number for the entity.

Error Handling

Code	Error Type	Description
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to view this domain
`404`	`NOT_FOUND`	Domain with given ID or FQN does not exist

Create a Domain

Update a Domain

⌘I

​Retrieve a Domain

​Get by ID

​Get by Fully Qualified Name

​Returns

​Response

​Error Handling

Retrieve a Domain

Get by ID

Get by Fully Qualified Name

Returns

Response

Error Handling