Search Automations
GET {{baseUrl}}/api/v2/automations/search?query=<string>&active=<boolean>&sort_by=<string>&sort_order=<string>&include=<string>
Pagination
- Offset pagination only
Allowed For
- Agents
Sideloads
The following sideloads are supported. For more information, see Side-loading.
| 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 |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
query | string | (Required) Query string used to find all automations with matching title | |
active | string | Filter by active automations if true or inactive automations if false | |
sort_by | string | Possible values are "alphabetical", "created_at", "updated_at", and "position". If unspecified, the automations are sorted by relevance | |
sort_order | string | One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others | |
include | string | A sideload to include in the response. See Sideloads |
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":9,"raw_title":"Close and Save","title":"Close and Save"},{"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":28,"position":9,"raw_title":"{{dc.close_and_redirect}}","title":"Close and redirect to topics"}],"count":2,"next_page":null,"previous_page":null}