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

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

# List all versions
versions = Topics.get_versions("0a021819-982e-4ee4-a5a2-4af30eaa3016")
for v in versions:
    print(f"Version {v.version}: {v.description}")

# Get a specific version
topic_v1 = Topics.get_specific_version(
    "0a021819-982e-4ee4-a5a2-4af30eaa3016",
    "0.1"
)
print(f"Original description: {topic_v1.description}")
{
  "entityType": "topic",
  "versions": [
    "{\"id\":\"0a021819-982e-4ee4-a5a2-4af30eaa3016\",\"name\":\"address_book\",\"fullyQualifiedName\":\"sample_kafka.address_book\",\"version\":0.2,\"description\":\"Updated: All Protobuf record events captured with enhanced schema\",\"serviceType\":\"Kafka\"}",
    "{\"id\":\"0a021819-982e-4ee4-a5a2-4af30eaa3016\",\"name\":\"address_book\",\"fullyQualifiedName\":\"sample_kafka.address_book\",\"version\":0.1,\"description\":\"All Protobuf record related events gets captured in this topic\",\"serviceType\":\"Kafka\"}"
  ]
}

Topic Versions

Every change to a topic 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 topic.

Get Specific Version

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

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

# List all versions
versions = Topics.get_versions("0a021819-982e-4ee4-a5a2-4af30eaa3016")
for v in versions:
    print(f"Version {v.version}: {v.description}")

# Get a specific version
topic_v1 = Topics.get_specific_version(
    "0a021819-982e-4ee4-a5a2-4af30eaa3016",
    "0.1"
)
print(f"Original description: {topic_v1.description}")
{
  "entityType": "topic",
  "versions": [
    "{\"id\":\"0a021819-982e-4ee4-a5a2-4af30eaa3016\",\"name\":\"address_book\",\"fullyQualifiedName\":\"sample_kafka.address_book\",\"version\":0.2,\"description\":\"Updated: All Protobuf record events captured with enhanced schema\",\"serviceType\":\"Kafka\"}",
    "{\"id\":\"0a021819-982e-4ee4-a5a2-4af30eaa3016\",\"name\":\"address_book\",\"fullyQualifiedName\":\"sample_kafka.address_book\",\"version\":0.1,\"description\":\"All Protobuf record related events gets captured in this topic\",\"serviceType\":\"Kafka\"}"
  ]
}

Returns

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

Error Handling

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