from metadata.sdk import configurefrom metadata.sdk.entities import DataContractsconfigure( host="https://your-company.getcollate.io/api", jwt_token="your-jwt-token")# List approved contractscontracts = DataContracts.list(filters={"status": "Approved"})for c in contracts.entities: print(f"{c.fullyQualifiedName.root} ({c.entityStatus})")# List contracts for a specific entitycontracts = DataContracts.list(filters={ "entity": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"})
import static org.openmetadata.sdk.fluent.DataContracts.*;// client is an initialized OpenMetadataClient.setDefaultClient(client);// List contracts with fluent APIlist().limit(20).fetch().forEach(contract -> { System.out.println(contract.getFqn() + " (" + contract.get().getEntityStatus() + ")");});
# List all contractscurl "{base_url}/api/v1/dataContracts?limit=10" \ -H "Authorization: Bearer {access_token}"# List approved contractscurl "{base_url}/api/v1/dataContracts?status=Approved&fields=owners" \ -H "Authorization: Bearer {access_token}"# List contracts for a specific entitycurl "{base_url}/api/v1/dataContracts?entity=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \ -H "Authorization: Bearer {access_token}"
List and filter data contracts with query parameters for ownership, status, entity type, and date ranges to manage data quality agreements using the Collate REST API.
GET
/
v1
/
dataContracts
GET /v1/dataContracts
from metadata.sdk import configurefrom metadata.sdk.entities import DataContractsconfigure( host="https://your-company.getcollate.io/api", jwt_token="your-jwt-token")# List approved contractscontracts = DataContracts.list(filters={"status": "Approved"})for c in contracts.entities: print(f"{c.fullyQualifiedName.root} ({c.entityStatus})")# List contracts for a specific entitycontracts = DataContracts.list(filters={ "entity": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"})
import static org.openmetadata.sdk.fluent.DataContracts.*;// client is an initialized OpenMetadataClient.setDefaultClient(client);// List contracts with fluent APIlist().limit(20).fetch().forEach(contract -> { System.out.println(contract.getFqn() + " (" + contract.get().getEntityStatus() + ")");});
# List all contractscurl "{base_url}/api/v1/dataContracts?limit=10" \ -H "Authorization: Bearer {access_token}"# List approved contractscurl "{base_url}/api/v1/dataContracts?status=Approved&fields=owners" \ -H "Authorization: Bearer {access_token}"# List contracts for a specific entitycurl "{base_url}/api/v1/dataContracts?entity=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \ -H "Authorization: Bearer {access_token}"
Retrieve a paginated list of data contracts, optionally filtered by status or entity.
Query Parameters
string
Comma-separated list of fields to include. Options: owners, reviewers, extension.
integer
default:"10"
Maximum number of contracts to return (0–1,000,000).
string
Cursor for backward pagination. Returns contracts before this cursor.
string
Cursor for forward pagination. Returns contracts after this cursor.
string
default:"non-deleted"
Filter by deletion status: all, deleted, or non-deleted.
string
Filter by contract status: Draft, In Review, Approved, Rejected, Deprecated, or Archived.
string
Filter by entity UUID. Returns only contracts attached to the specified entity.
GET /v1/dataContracts
from metadata.sdk import configurefrom metadata.sdk.entities import DataContractsconfigure( host="https://your-company.getcollate.io/api", jwt_token="your-jwt-token")# List approved contractscontracts = DataContracts.list(filters={"status": "Approved"})for c in contracts.entities: print(f"{c.fullyQualifiedName.root} ({c.entityStatus})")# List contracts for a specific entitycontracts = DataContracts.list(filters={ "entity": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"})
import static org.openmetadata.sdk.fluent.DataContracts.*;// client is an initialized OpenMetadataClient.setDefaultClient(client);// List contracts with fluent APIlist().limit(20).fetch().forEach(contract -> { System.out.println(contract.getFqn() + " (" + contract.get().getEntityStatus() + ")");});
# List all contractscurl "{base_url}/api/v1/dataContracts?limit=10" \ -H "Authorization: Bearer {access_token}"# List approved contractscurl "{base_url}/api/v1/dataContracts?status=Approved&fields=owners" \ -H "Authorization: Bearer {access_token}"# List contracts for a specific entitycurl "{base_url}/api/v1/dataContracts?entity=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \ -H "Authorization: Bearer {access_token}"