API ReferenceMinis

Get a Mini version

Retrieve a single version of a Mini.

Authentication

AuthorizationBearer

Authenticate every request with Authorization: Bearer <api-key>. Manage keys in Workspace Admin > Security & access.

Path parameters

idstringRequired

Either the Minikai-assigned Guid for this resource (e.g. abc12345-1234-1234-1234-123456789abc) or the resource’s externalUri, URL-encoded (e.g. https%3A%2F%2Fpartner.example.com%2Fpatients%2F48291). Responses always return the canonical Guid in the id field.

versionIdstringRequired

Response

OK
idstring
miniIdstring
namestring
createdBystring
profilePictureUrlstringOptionalformat: "uri"
profileanyOptional
dateOfBirthdate or nullOptional
identitieslist of objectsOptional
agentTypeenumOptional
externalUristringOptionalformat: "uri"
createdAtdatetimeOptional
updatedAtdatetimeOptional
updatedBystring or nullOptional

Errors

404
Not Found Error