API reference · Automation
GET/api/v1/automation/templates

List automation templates

Returns a paginated list of automation templates for the authenticated tenant. Authentication uses x-api-key with optional x-tenant-id; RBAC requires automation:read. The controller validates query params with templatesListSchema and the service filters automation_templates by tenant. Current service code wraps template array before createPaginatedResponse, which can produce nested data in practice.

RBAC · automation

Query parameters

pagestringOptional
Page number as a query string. Defaults to 1.
limitstringOptional
Page size as a query string. Must parse to 1 through 100; defaults to 25.
sortstringOptional
Accepted by shared list query validation; service currently orders templates by created_at desc.
orderstringOptional
Accepted by shared list query validation.
searchstringOptional
Accepted by shared filter validation.
created_fromstring <date-time>Optional
Accepted by shared filter validation.
created_tostring <date-time>Optional
Accepted by shared filter validation.
updated_fromstring <date-time>Optional
Accepted by shared filter validation.
updated_tostring <date-time>Optional
Accepted by shared filter validation.
is_activestringOptional
Accepted by shared filter validation and transformed to boolean.
categorystringOptional
Filter templates by category.
compatible_versionstringOptional
Filter templates by compatibility version tag.
authorstringOptional
Filter templates by author/user id value saved on the template.
usage_count_minintegerOptional
Minimum usage_count filter.
usage_count_maxintegerOptional
Maximum usage_count filter.

Response body

Success response 200 · schema AutomationTemplateListResponse

dataarray of AutomationTemplateRequired
Template rows. Current service code wraps the DB result array in another array before createPaginatedResponse, which can produce nested data in practice.
itemsobject
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
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.
paginationobjectRequired
pageintegerRequired
Current page number.
limitintegerRequired
Page size.
totalintegerRequired
Total matching executions.
totalPagesintegerRequired
Total page count.
hasNextbooleanRequired
Whether another page exists.
hasPrevbooleanRequired
Whether a previous page exists.
metaobject
filtersobject
resourcestring
Enum: automation_template

Response codes

200
Automation templates returned successfully.
400
Query parameter validation failed.
401
API key is missing, invalid, expired, over limit, or the key user was not found.
403
Authenticated user lacks automation:read permission.
500
Unexpected automation templates listing failure.