---
title: "List Active Automations"
method: GET
path: "/api/v2/automations/active"
tags: ["Automations"]
---

# List Active Automations

`GET /api/v2/automations/active`

Lists all active automations.

#### Allowed For

* Agents

#### Available Parameters

You can pass in any combination of the following optional filters:

| Name       | Type   | Comment
| ---------- | ------ | -------
| 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:

| 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

## Response `200`

Success response

- AutomationsResponse
  - `automations` AutomationObject[]
    - `actions` ActionObject[] — An object describing what the automation will do. See [Actions reference](/documentation/ticketing/reference-guides/actions-reference)
      - `field` string — The name of a ticket field to modify
      - `value` string — The new value of the field
    - `active` boolean — Whether the automation is active
    - `conditions` ConditionsObject — An object that describes the conditions under which the automation will execute. See [Conditions reference](/documentation/ticketing/reference-guides/conditions-reference)
      - `all` ConditionObject[] — Logical AND. Tickets must fulfill all of the conditions to be considered matching
        - `field` string — The name of a ticket field
        - `operator` string — A comparison operator
        - `value` string — The value of a ticket field
      - `any` ConditionObject[] — Logical OR. Tickets may satisfy any of the conditions to be considered matching
        - `field` string — The name of a ticket field
        - `operator` string — A comparison operator
        - `value` string — The value of a ticket field
    - `created_at` string, date-time — The time the automation was created
    - `default` boolean — If true, the automation is a default automation
    - `id` integer — Automatically assigned when created
    - `position` integer — The position of the automation which specifies the order it will be executed
    - `raw_title` string — The raw title of the automation
    - `title` string — The title of the automation
    - `updated_at` string, date-time — The time of the last update of the automation
  - `count` integer
  - `next_page` string, nullable
  - `previous_page` string, nullable

---

[API](https://skmtc.dev/botbrains-io/apis/support-api.md) · [All operations](https://skmtc.dev/botbrains-io/apis/support-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/botbrains-io/support-api/revisions/d53eac07ba68/schema)