> For the complete documentation index, see [llms.txt](https://docs.shortcutco.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shortcutco.com/developers/api-reference/reference/objects/automation.md).

# The automation object

The automation object in the Shortcut API - every field, an example, and the endpoints that return it.

An automation: a rule that emails, texts, or creates tasks when something happens.

## Fields

| Field                   | Type                             | Description                                          |
| ----------------------- | -------------------------------- | ---------------------------------------------------- |
| `id`                    | string                           | The automation's id.                                 |
| `object`                | `"automation"`                   | Always `automation`.                                 |
| `name`                  | string                           | Its name.                                            |
| `status`                | `active`, `inactive`, `archived` | `active`: running.                                   |
| `channels`              | array of `email`, `sms`          | How it reaches customers.                            |
| `activeRuns`            | integer                          | Customers part-way through it now.                   |
| `hasUnpublishedChanges` | boolean                          | Whether someone is editing it and has not published. |

## Example

```json
{
  "id": "Example id",
  "object": "automation",
  "name": "Weekly mowing",
  "status": "active",
  "channels": [
    "email"
  ],
  "activeRuns": 1,
  "hasUnpublishedChanges": false
}
```

## Endpoints

| Endpoint              | What it does     |
| --------------------- | ---------------- |
| `GET /v1/automations` | List automations |
