Terms - List
Lists terms with optional domain/parent/keyword filters and pagination. Rate limit: 100 requests per 20-second window.
GET {endpoint}/datagovernance/catalog/terms?api-version=2026-03-20-preview
GET {endpoint}/datagovernance/catalog/terms?api-version=2026-03-20-preview&skip={skip}&top={top}&domainId={domainId}&parentId={parentId}&keyword={keyword}&depth={depth}&orderBy={orderBy}
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
The endpoint of the Purview Unified Catalog service. Example: https://api.purview-service.microsoft.com/ |
|
api-version
|
query | True |
string minLength: 1 |
The API version to use for this operation. |
|
depth
|
query |
integer (int32) |
The depth of the term. |
|
|
domain
|
query |
string (uuid) |
The unique identifier of the domain. |
|
|
keyword
|
query |
string |
Search keyword. |
|
|
order
|
query |
string |
Expressions that specify the order of returned results. |
|
|
parent
|
query |
string (uuid) |
The unique identifier of the parent term. |
|
|
skip
|
query |
integer (int32) |
The number of result items to skip. |
|
|
top
|
query |
integer (int32) |
The number of result items to return. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
The request has succeeded. |
|
| Other Status Codes |
An unexpected error response. Headers x-ms-error-code: string |
Security
OAuth2Auth
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name | Description |
|---|---|
| https://purview.azure.net/.default |
Examples
Terms_List
Sample request
GET {endpoint}/datagovernance/catalog/terms?api-version=2026-03-20-preview&skip=0&top=10&domainId=7e74f902-62f5-49f4-8258-92ed2b8537ba&parentId=7e74f902-62f5-49f4-8258-92ed2b8537ba&keyword=example&depth=2&orderBy=name desc
Sample response
{
"value": [
{
"id": "4e74f902-62f5-49f4-8258-92ed2b8537ba",
"name": "myDataProduct",
"systemData": {
"lastModifiedAt": "1970-01-01T00:00:00.000Z",
"lastModifiedBy": "766BF2B9-5D8A-4FB1-B8D5-D30A53E22A9E",
"createdAt": "1970-01-01T00:00:00.000Z",
"createdBy": "766BF2B9-5D8A-4FB1-B8D5-D30A53E22A9E",
"expiredAt": "1970-01-01T00:00:00.000Z",
"expiredBy": "766BF2B9-5D8A-4FB1-B8D5-D30A53E22A9E"
},
"description": "This term describes the company global revenue",
"contacts": {
"owner": [
{
"id": "4e74f902-62f5-49f4-8258-92ed2b8537ba",
"description": "db1"
},
{
"id": "5e74f902-62f5-49f4-8258-92ed2b8537ba",
"description": "db2"
}
]
},
"domain": "7e74f902-62f5-49f4-8258-92ed2b8537ba",
"status": "DRAFT",
"parentId": "3e74f902-62f5-49f4-8258-92ed2b8537ba",
"acronyms": [
"FTX",
"SBF"
],
"resources": [
{
"name": "myDataProduct",
"url": "https://www.microsoft.com"
}
]
}
]
}
Definitions
| Name | Description |
|---|---|
|
Azure. |
The error object. |
|
Azure. |
A response containing error details. |
|
Azure. |
An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors. |
|
Catalog |
Contact information for catalog entities. |
|
Catalog |
Managed attribute configuration for catalog entities. |
|
Catalog |
Status of a catalog model entity indicating its lifecycle state. |
|
Catalog |
System metadata with expiration information for catalog entities. |
|
Catalog |
Catalog model term resource. |
|
Contacts |
A dictionary of contact lists keyed by contact type (e.g., 'Owner', 'Expert'). |
|
Data |
The provisioning state of a data asset. |
|
Paged |
Paged collection of Term items |
| Term |
Microsoft Purview Data Governance Catalog Model Term. |
Azure.Core.Foundations.Error
The error object.
| Name | Type | Description |
|---|---|---|
| code |
string |
One of a server-defined set of error codes. |
| details |
An array of details about specific errors that led to this reported error. |
|
| innererror |
An object containing more specific information than the current object about the error. |
|
| message |
string |
A human-readable representation of the error. |
| target |
string |
The target of the error. |
Azure.Core.Foundations.ErrorResponse
A response containing error details.
| Name | Type | Description |
|---|---|---|
| error |
The error object. |
Azure.Core.Foundations.InnerError
An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.
| Name | Type | Description |
|---|---|---|
| code |
string |
One of a server-defined set of error codes. |
| innererror |
Inner error. |
CatalogModelContactsValueInner
Contact information for catalog entities.
| Name | Type | Description |
|---|---|---|
| description |
string |
A description of this user assignment |
| id |
string (uuid) |
AAD oid for the person or group |
CatalogModelManagedAttribute
Managed attribute configuration for catalog entities.
| Name | Type | Description |
|---|---|---|
| isRequired |
boolean |
Whether this attribute is required. |
| name |
string |
The name of the managed attribute. |
| value |
string |
The value of the attribute. |
CatalogModelStatus
Status of a catalog model entity indicating its lifecycle state.
| Value | Description |
|---|---|
| DRAFT |
The entity is in draft state. |
| PUBLISHED |
The entity is published and active. |
| EXPIRED |
The entity has expired and is no longer active. |
CatalogModelSystemDataWithExpired
System metadata with expiration information for catalog entities.
| Name | Type | Description |
|---|---|---|
| createdAt |
string (date-time) |
The timestamp when the record was created. |
| createdBy |
string (uuid) |
The unique identifier of the user who created the record. |
| expiredAt |
string (date-time) |
The timestamp when the record expires. |
| expiredBy |
string (uuid) |
The unique identifier of the user who expired the record. |
| lastModifiedAt |
string (date-time) |
The timestamp when the record was last modified. |
| lastModifiedBy |
string (uuid) |
The unique identifier of the user who last modified the record. |
| provisioningState |
The provisioning state of the record. ex: softdeleted |
CatalogModelTermResource
Catalog model term resource.
| Name | Type | Description |
|---|---|---|
| name |
string |
The name of the resource. |
| url |
string (uri) |
The URL of the resource. |
ContactsMap
A dictionary of contact lists keyed by contact type (e.g., 'Owner', 'Expert').
| Name | Type | Description |
|---|---|---|
| databaseAdmin |
List of database administrator contacts. |
|
| expert |
List of expert contacts. |
|
| owner |
List of owner contacts. |
DataAssetProvisioningState
The provisioning state of a data asset.
| Value | Description |
|---|---|
| Unknown |
The provisioning state is unknown. |
| Succeeded |
The resource has been successfully provisioned. |
| SoftDeleted |
The resource has been soft deleted. |
PagedTerm
Paged collection of Term items
| Name | Type | Description |
|---|---|---|
| nextLink |
string (uri) |
The link to the next page of items |
| value |
Term[] |
The Term items on this page |
Term
Microsoft Purview Data Governance Catalog Model Term.
| Name | Type | Description |
|---|---|---|
| acronyms |
string[] |
The list of acronyms for the term. |
| contacts |
The contacts associated with the term. |
|
| description |
string |
The description of the term. |
| domain |
string (uuid) |
The domain associated with the term. |
| id |
string (uuid) |
The unique identifier of the term. |
| isLeaf |
boolean |
Whether the term is a leaf node. |
| managedAttributes |
The managed attributes associated with the term. |
|
| name |
string |
The name of the term. |
| parentId |
string (uuid) |
The parent term identifier. |
| resources |
The resources associated with the term. |
|
| status |
The status of the term. |
|
| systemData |
The system data of the term. |