API reference · Automation
GET/api/v1/automation/templates/{id}
Product availabilityAlgaPSA

Get automation template

Returns one automation template by template_id for the authenticated tenant. Authentication uses x-api-key with optional x-tenant-id; RBAC requires automation:read. Service lookup is scoped by {template_id, tenant}. Missing templates currently throw generic Error and surface as 500 rather than 404.

RBAC · automation

Path parameters

idstring <uuid>Required
Automation template UUID from automation_templates.template_id.

Response body

Success response 200 · schema AutomationTemplateResponse

dataobjectRequired
template_idstring <uuid>Required
Template UUID generated with crypto.randomUUID.
namestringRequired
descriptionstringNullable
categorystringRequired
iconstringNullable
template_configobjectRequired
Template rule blueprint derived from an automation rule.
versionstring
authorstringNullable
compatible_versionsarray of string
itemsstring
required_permissionsarray of string
itemsstring
usage_countinteger
≥ 0
last_usedstring <date-time>Nullable
template_variablesarray of AutomationTemplateVariable
itemsobject
namestringRequired
display_namestring
descriptionstring
typestringRequired
Enum: stringnumberbooleandateselectmultiselect
requiredboolean
default_valueany
optionsarray of object
itemsobject
labelstringRequired
valueany
validationobject
minnumber
maxnumber
patternstring
custom_validatorstring
is_activeboolean
is_featuredboolean
tenantstring <uuid>Required
_linksobject
HATEOAS links generated by the automation controller. Some generic links may point to methods not implemented by a route file.

Response codes

200
Automation template returned successfully.
400
Invalid template UUID format.
401
API key is missing, invalid, expired, over limit, or the key user was not found.
403
Authenticated user lacks automation:read permission.
404
Intended not-found response for missing templates; current service may surface this as 500.
500
Unexpected failure, including current generic not-found errors.