Docs

Get Entity Schemas

GET /organizations/{organizationId}/templates/schema

GET/organizations/{organizationId}/templates/schema

Lists the entity types a template can contain, each with its display name, description, the entity types it depends on, and its properties. Use it to build valid input for Templates_AddTemplateEntity and Templates_UpdateTemplateEntity.

Path Parameters

FieldTypeRequiredDescription
organizationIduuidRequired

Response

Type: TemplateEntitySchema[]

TemplateEntitySchema

FieldTypeDescription
entityTypestring| null
displayNamestring| null
descriptionstring| null
dependsOnstring[]| null
propertiesPropertySchema[]| null

PropertySchema

FieldTypeDescription
namestring| null
typestring| null
isRequiredboolean
descriptionstring| null
refEntityTypestring| null