Automations
List Automations
Lists all automations for the current account.
Allowed For
- Agents
Available Parameters
You can pass in any combination of the following optional filters:
| Name | Type | Comment |
|---|---|---|
| active | boolean | Only active automations if true, inactive automations if false |
| sort_by | string | Possible values are "alphabetical", "created_at", "updated_at", "usage_1h", "usage_24h", or "usage_7d". Defaults to "position" |
| sort_order | string | One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others |
Sideloads
The following sideloads are supported. The usage sideloads are only supported on the Support Professional or Suite Growth plan or above.
| Name | Will sideload |
|---|---|
| app_installation | The app installation that requires each automation, if present |
| permissions | The permissions for each automation |
| usage_1h | The number of times each automation has been used in the past hour |
| usage_24h | The number of times each automation has been used in the past day |
| usage_7d | The number of times each automation has been used in the past week |
| usage_30d | The number of times each automation has been used in the past thirty days |
Pagination
- Cursor pagination (recommended)
- Offset pagination
See Pagination.
Returns a maximum of 100 records per page.
get/api/v2/automations
Response
Success response
Example response
{
"automations": [
{
"actions": [
{
"field": "priority",
"value": "high"
}
],
"active": true,
"conditions": {
"all": [
{
"field": "status",
"operator": "is",
"value": "open"
},
{
"field": "priority",
"operator": "less_than",
"value": "high"
}
],
"any": []
},
"default": false,
"id": 9873843,
"position": 8,
"raw_title": "Roger Wilco",
"title": "Roger Wilco"
}
]
}