Skip to main content
GET
GET /v1/dataContracts/{id}

Retrieve a Data Contract

Get a data contract by its UUID, fully qualified name, or the entity it’s attached to.

Get by ID

string
required
UUID of the data contract.
string
Comma-separated list of fields to include: owners, reviewers, extension.
string
default:"non-deleted"
Include filter: all, deleted, or non-deleted.

Get by Fully Qualified Name

Use GET /v1/dataContracts/name/{fqn} with the same query parameters.

Get Effective Contract for Entity

Use GET /v1/dataContracts/entity to get the effective contract for an entity, including inherited properties from its data product.
string
required
UUID of the entity.
string
required
Type of the entity (e.g., table, topic, dashboard).
string
Comma-separated list of fields to include.
GET /v1/dataContracts/{id}

Response Fields

string
UUID of the data contract.
string
Name of the data contract.
string
Fully qualified name.
string
Contract status: Draft, Active, or Deprecated.
object
Reference to the data asset this contract applies to.
array
Expected column definitions.
array
Semantics rules.
array
References to test cases.
object
SLA expectations (refresh frequency, latency, availability).
string
Terms of use in Markdown.
object
Security and access policy expectations.
boolean
Whether this contract is inherited from a data product.
object
Latest validation result summary.
array
Owner references.
array
Reviewer references.
number
Entity version.

Error Handling