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

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

# List all versions
versions = Tags.get_versions("68ec158c-5f5e-4277-8a19-5e9e0cd5294f")
for v in versions:
    print(f"Version {v.version}: {v.description}")

# Get a specific version
tag_v1 = Tags.get_specific_version(
    "68ec158c-5f5e-4277-8a19-5e9e0cd5294f",
    "0.1"
)
print(f"Original description: {tag_v1.description}")
{
  "entityType": "tag",
  "versions": [
    "{\"id\":\"68ec158c-5f5e-4277-8a19-5e9e0cd5294f\",\"name\":\"Bronze\",\"fullyQualifiedName\":\"Certification.Bronze\",\"version\":0.2,\"description\":\"Updated description\",\"style\":{\"color\":\"#D4A017\"}}",
    "{\"id\":\"68ec158c-5f5e-4277-8a19-5e9e0cd5294f\",\"name\":\"Bronze\",\"fullyQualifiedName\":\"Certification.Bronze\",\"version\":0.1,\"description\":\"Bronze certified Data Asset.\",\"style\":{\"color\":\"#C08320\"}}"
  ]
}

Tag Versions

Every change to a tag entity creates a new version. Use these endpoints to view the version history and retrieve specific versions.

List Versions

id
string
required
UUID of the tag.

Get Specific Version

Use GET /v1/tags/{id}/versions/{version} to retrieve a specific version.
id
string
required
UUID of the tag.
version
string
required
Version number to retrieve (e.g., 0.2).
GET /v1/tags/{id}/versions
from metadata.sdk import configure
from metadata.sdk.entities import Tags

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

# List all versions
versions = Tags.get_versions("68ec158c-5f5e-4277-8a19-5e9e0cd5294f")
for v in versions:
    print(f"Version {v.version}: {v.description}")

# Get a specific version
tag_v1 = Tags.get_specific_version(
    "68ec158c-5f5e-4277-8a19-5e9e0cd5294f",
    "0.1"
)
print(f"Original description: {tag_v1.description}")
{
  "entityType": "tag",
  "versions": [
    "{\"id\":\"68ec158c-5f5e-4277-8a19-5e9e0cd5294f\",\"name\":\"Bronze\",\"fullyQualifiedName\":\"Certification.Bronze\",\"version\":0.2,\"description\":\"Updated description\",\"style\":{\"color\":\"#D4A017\"}}",
    "{\"id\":\"68ec158c-5f5e-4277-8a19-5e9e0cd5294f\",\"name\":\"Bronze\",\"fullyQualifiedName\":\"Certification.Bronze\",\"version\":0.1,\"description\":\"Bronze certified Data Asset.\",\"style\":{\"color\":\"#C08320\"}}"
  ]
}

Returns

List versions returns an object with entityType and a versions array of serialized entity snapshots (newest first). Get specific version returns the full tag object as it existed at that version.

Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
404NOT_FOUNDTag or version does not exist