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

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

# List all versions
versions = Users.get_versions("77655e6e-ad33-49da-bbca-db4ba4d4e2cd")
for v in versions:
    print(f"Version {v.version}: {v.description}")

# Get a specific version
user_v1 = Users.get_specific_version(
    "77655e6e-ad33-49da-bbca-db4ba4d4e2cd",
    "0.1"
)
print(f"Original display name: {user_v1.displayName}")

{
  "entityType": "user",
  "versions": [
    "{\"id\":\"77655e6e-ad33-49da-bbca-db4ba4d4e2cd\",\"name\":\"aaron_johnson0\",\"fullyQualifiedName\":\"aaron_johnson0\",\"version\":0.2,\"displayName\":\"Aaron M. Johnson\",\"email\":\"[email protected]\",\"isBot\":false,\"isAdmin\":false}",
    "{\"id\":\"77655e6e-ad33-49da-bbca-db4ba4d4e2cd\",\"name\":\"aaron_johnson0\",\"fullyQualifiedName\":\"aaron_johnson0\",\"version\":0.1,\"displayName\":\"Aaron Johnson\",\"email\":\"[email protected]\",\"isBot\":false,\"isAdmin\":false}"
  ]
}

​
User Versions

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

​
Get Specific Version

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

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

# List all versions
versions = Users.get_versions("77655e6e-ad33-49da-bbca-db4ba4d4e2cd")
for v in versions:
    print(f"Version {v.version}: {v.description}")

# Get a specific version
user_v1 = Users.get_specific_version(
    "77655e6e-ad33-49da-bbca-db4ba4d4e2cd",
    "0.1"
)
print(f"Original display name: {user_v1.displayName}")

{
  "entityType": "user",
  "versions": [
    "{\"id\":\"77655e6e-ad33-49da-bbca-db4ba4d4e2cd\",\"name\":\"aaron_johnson0\",\"fullyQualifiedName\":\"aaron_johnson0\",\"version\":0.2,\"displayName\":\"Aaron M. Johnson\",\"email\":\"[email protected]\",\"isBot\":false,\"isAdmin\":false}",
    "{\"id\":\"77655e6e-ad33-49da-bbca-db4ba4d4e2cd\",\"name\":\"aaron_johnson0\",\"fullyQualifiedName\":\"aaron_johnson0\",\"version\":0.1,\"displayName\":\"Aaron Johnson\",\"email\":\"[email protected]\",\"isBot\":false,\"isAdmin\":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 user object as it existed at that version.

​
Error Handling

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