Automations
List
Returns the tenant's automation rules with their conditions and actions, with referenced fields, Users, groups and list entries
resolved to labels, always sorted by execution order.
Paging cannot be controlled here: take and page from the filter are overridden with 1000 and 1, while search and property
filters still apply.
GET
/api/{tenant:minlength(2)}/v{version:apiVersion}/automations
- Authorisation
- Minimum role: USER
Request arguments
Request body example
Response
- Status
- 200 (OK)
- Type
- DTO_automation[]
- Wrapper
- DTO_response_wrap_get_many
- Other statuses
- 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_standard_filter
| Name | Type | ReadOnly | Description |
|---|
| sort_by_key | String | | Sort by key |
| response_field_keys | String[] | | Only return the fields specified |
| filters | String[] | | Each string needs to be structured: filters=field_key:operator:value1|value2|value3
Only used to store filters for passing along as querystring |
| include_aggregations | Boolean | | Include aggregations |
| include_imported | Boolean | | Include imported |
| search | String | | Search |
| sort_order | ENUM sort_order | | Sort order |
| take | Int32 | | Take |
| page | Int32 | | Page |
DTO_automation_condition_group
DTO_automation_value
| Name | Type | ReadOnly | Description |
|---|
| id | Int32 | | The id of the reference |
| label | Object | | Label |
DTO_automation_action
| Name | Type | ReadOnly | Description |
|---|
| value | DTO_automation_value | | Deprecated in favour of , but still read on input and always populated on output
(with the first entry of ) so existing API clients keep working. |
| values | DTO_automation_value[] | | All values the action sets. Only fields that accept several values at once - tags and PICK_MANY
custom fields - may hold more than one entry; every other field is limited to a single value. |
| field_key | String | | Field key |
| action_type | ENUM automation_action_type | | Action type |
DTO_reference_user
| Name | Type | ReadOnly | Description |
|---|
| profile_pic | String | ReadOnly | Profile pic |
| email | String | ReadOnly | Email |
| id | Int32 | | Id |
| label | Object | ReadOnly | Label |
ENUM automation_conditions_operator
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | AND | AND |
| 2 | OR | OR |
ENUM automation_condition_type
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | CONTAINS | Contains |
| 2 | NOT_CONTAINS | Doesn't contain |
| 3 | EQUAL | Equals |
| 4 | NOT_EQUAL | Not equal |
| 5 | CHANGED_TO_EQUAL | Only for update triggers |
| 6 | CHANGED_TO_NOT_EQUAL | Only for update triggers |
| 7 | AI_EVALUATED | Only for create trigger in combination with specific "any" key |
ENUM automation_action_type
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | SET_VALUE | Set value |
| 2 | SET_SLA | Set SLA |
| 3 | SEND_NOTIFICATION | Send notification |
ENUM sort_order
| Value | Name | Description |
|---|
| 0 | ASC | ASC |
| 1 | DESC | DESC |
ENUM automation_trigger_by
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | TICKET_NEW | New ticket |
| 2 | TICKET_UPDATE | Ticket update |
| 2 | TICKET_SLA_BREACH | Ticket update |
ENUM automation_type
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | SYS_LOCKED_SETTINGS | Only the values can be changed |
| 2 | CUSTOM | Custom |
Generated Aug 4, 2026 18:37
