Skip to main content
GET
https://sandbox.getcollate.io/api
/
v1
/
services
/
messagingServices
/
{id}
/
versions
GET /v1/services/messagingServices/{id}/versions
import requests

base_url = "https://your-company.getcollate.io/api"
headers = {"Authorization": "Bearer your-jwt-token"}

# List all versions
response = requests.get(
    f"{base_url}/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30/versions",
    headers=headers
)
versions = response.json()
for v in versions["versions"]:
    print(v)

# Get a specific version
response = requests.get(
    f"{base_url}/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30/versions/0.1",
    headers=headers
)
service_v1 = response.json()
print(f"Original description: {service_v1.get('description')}")

{
  "entityType": "messagingService",
  "versions": [
    "{\"id\":\"469ef25e-9bdf-4d5f-8553-eb0ce8581f30\",\"name\":\"sample_kafka\",\"fullyQualifiedName\":\"sample_kafka\",\"serviceType\":\"Kafka\",\"description\":\"Updated Kafka messaging service\",\"version\":0.2,\"updatedAt\":1769982700000,\"updatedBy\":\"admin\",\"deleted\":false}",
    "{\"id\":\"469ef25e-9bdf-4d5f-8553-eb0ce8581f30\",\"name\":\"sample_kafka\",\"fullyQualifiedName\":\"sample_kafka\",\"serviceType\":\"Kafka\",\"version\":0.1,\"updatedAt\":1769982621031,\"updatedBy\":\"admin\",\"deleted\":false}"
  ]
}

​
Messaging Service Versions

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

​
Get Specific Version

Use GET /v1/services/messagingServices/{id}/versions/{version} to retrieve a specific version.
​
id
string
required
UUID of the messaging service.
​
version
string
required
Version number to retrieve (e.g., 0.2).
GET /v1/services/messagingServices/{id}/versions
import requests

base_url = "https://your-company.getcollate.io/api"
headers = {"Authorization": "Bearer your-jwt-token"}

# List all versions
response = requests.get(
    f"{base_url}/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30/versions",
    headers=headers
)
versions = response.json()
for v in versions["versions"]:
    print(v)

# Get a specific version
response = requests.get(
    f"{base_url}/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30/versions/0.1",
    headers=headers
)
service_v1 = response.json()
print(f"Original description: {service_v1.get('description')}")

{
  "entityType": "messagingService",
  "versions": [
    "{\"id\":\"469ef25e-9bdf-4d5f-8553-eb0ce8581f30\",\"name\":\"sample_kafka\",\"fullyQualifiedName\":\"sample_kafka\",\"serviceType\":\"Kafka\",\"description\":\"Updated Kafka messaging service\",\"version\":0.2,\"updatedAt\":1769982700000,\"updatedBy\":\"admin\",\"deleted\":false}",
    "{\"id\":\"469ef25e-9bdf-4d5f-8553-eb0ce8581f30\",\"name\":\"sample_kafka\",\"fullyQualifiedName\":\"sample_kafka\",\"serviceType\":\"Kafka\",\"version\":0.1,\"updatedAt\":1769982621031,\"updatedBy\":\"admin\",\"deleted\":false}"
  ]
}

​
Returns

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

​
Error Handling

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