List Automations
GET {{baseUrl}}/api/v2/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 ascor desc. Defaults to ascfor alphabetical and position sort, descfor 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.
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"automations":[{"actions":[{"field":"status","value":"open"},{"field":"assignee_id","value":"296220096"}],"active":true,"conditions":{"all":[{"field":"status","operator":"less_than","value":"solved"},{"field":"assignee_id","operator":"is","value":"296220096"}],"any":[{"field":"current_tags","operator":"includes","value":"hello"}]},"id":25,"position":8,"raw_title":"Close and Save","title":"Close and Save"},{"actions":[{"field":"status","value":"open"},{"field":"assignee_id","value":"296220096"}],"active":false,"conditions":{"all":[{"field":"status","operator":"less_than","value":"solved"},{"field":"assignee_id","operator":"is","value":"296220096"}],"any":[{"field":"current_tags","operator":"includes","value":"hello"}]},"id":26,"position":9,"raw_title":"{{dc.assign_priority_tag}}","title":"Assign priority tag"}],"count":2,"next_page":null,"previous_page":null}