Skip to main content
GET
https://sandbox.getcollate.io/api
/
v1
/
classifications
/
{id}
GET /v1/classifications/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Classifications

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

# Get by ID
classification = Classifications.retrieve("06d90883-6be9-4f7e-9475-753f10a95e94")
print(f"{classification.fullyQualifiedName}: {classification.description}")

# Get by ID with fields
classification = Classifications.retrieve(
    "06d90883-6be9-4f7e-9475-753f10a95e94",
    fields=["owners"]
)

# Get by fully qualified name
classification = Classifications.retrieve_by_name("Certification")

# Get by name with fields
classification = Classifications.retrieve_by_name(
    "Certification",
    fields=["owners"]
)

{
  "id": "06d90883-6be9-4f7e-9475-753f10a95e94",
  "name": "Certification",
  "fullyQualifiedName": "Certification",
  "description": "Certifying Data Asset will provide the users with a clear idea of...",
  "version": 0.1,
  "updatedAt": 1769982619610,
  "updatedBy": "admin",
  "deleted": false,
  "owners": [],
  "provider": "system",
  "mutuallyExclusive": true
}

​
Retrieve a Classification

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

​
Get by ID

​
id
string
required
UUID of the classification to retrieve.
​
fields
string
Comma-separated list of fields to include (e.g., owners).
​
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.

​
Get by Fully Qualified Name

Use GET /v1/classifications/name/{fqn} to retrieve by fully qualified name.
​
fqn
string
required
Fully qualified name of the classification (e.g., Certification).
​
fields
string
Comma-separated list of fields to include: owners.
​
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/classifications/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Classifications

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

# Get by ID
classification = Classifications.retrieve("06d90883-6be9-4f7e-9475-753f10a95e94")
print(f"{classification.fullyQualifiedName}: {classification.description}")

# Get by ID with fields
classification = Classifications.retrieve(
    "06d90883-6be9-4f7e-9475-753f10a95e94",
    fields=["owners"]
)

# Get by fully qualified name
classification = Classifications.retrieve_by_name("Certification")

# Get by name with fields
classification = Classifications.retrieve_by_name(
    "Certification",
    fields=["owners"]
)

{
  "id": "06d90883-6be9-4f7e-9475-753f10a95e94",
  "name": "Certification",
  "fullyQualifiedName": "Certification",
  "description": "Certifying Data Asset will provide the users with a clear idea of...",
  "version": 0.1,
  "updatedAt": 1769982619610,
  "updatedBy": "admin",
  "deleted": false,
  "owners": [],
  "provider": "system",
  "mutuallyExclusive": true
}

​
Returns

Returns a classification object with all requested fields populated.

​
Response

​
id
string
Unique identifier for the classification (UUID format).
​
name
string
Classification name.
​
fullyQualifiedName
string
Fully qualified name of the classification.
​
displayName
string
Human-readable display name.
​
description
string
Description of the classification in Markdown format.
​
mutuallyExclusive
boolean
Whether tags in this classification are mutually exclusive.
​
provider
string
Provider: user or system.
​
owners
array
List of owners. Only included when fields contains owners.
​
version
number
Version number for the entity.

​
Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to view this classification
404NOT_FOUNDClassification with given ID or FQN does not exist