---
title: "List Automation definitions"
description: "Lists owner-private Automation definitions in the API key workspace. Traverse the bounded result set with the returned opaque cursor."
canonical: https://y2.dev/docs/api/reference/automations/listAutomations/
---

Endpoint Reference[Automations](https://y2.dev/docs/api/reference/automations)

# List Automation definitions

Lists owner-private Automation definitions in the API key workspace. Traverse the bounded result set with the returned opaque cursor.

`GET https://api.y2.dev/api/v1/automations`

- Operation ID: `listAutomations`
- Required scopes: `automations:read`
- Contract: https://y2.dev/openapi.json

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `cursor` | query | string | No | Opaque continuation token from the previous response. Bound to the original filters and ordering. |
| `projectId` | query | string | No |  |
| `status` | query | `AutomationStatus` | No |  |
| `limit` | query | integer | No |  |

## Responses

| Status | Description | Body |
| --- | --- | --- |
| 200 | Bounded Automation list | `AutomationListResponse` |
| 400 | Invalid request parameters |  |
| 401 | Missing or invalid API key |  |
| 403 | Insufficient permissions or access denied |  |
| 429 | Rate limit exceeded (per-key or per-account aggregate) |  |
| 500 | Internal server error |  |

### 200 response fields

| Field | Type | Description |
| --- | --- | --- |
| `data[]` | array of `Automation` |  |
| `data[].id` | string |  |
| `data[].type` | string |  |
| `data[].name` | string |  |
| `data[].instructions` | string |  |
| `data[].operation` | string |  |
| `data[].projectId` | string or null |  |
| `data[].trigger` | `AutomationTrigger` |  |
| `data[].notificationPolicy` | `all_runs`, `failures_only`, `none` |  |
| `data[].overlapPolicy` | string |  |
| `data[].status` | `AutomationStatus` |  |
| `data[].definitionRevision` | integer |  |
| `data[].schedule` | null or `AutomationSchedule` |  |
| `data[].lastRun` | null or `AutomationRun` |  |
| `data[].createdAt` | string (date-time) |  |
| `data[].updatedAt` | string (date-time) |  |
| `data[].links` | object |  |
| `meta` | object |  |
| `meta.count` | integer |  |
| `meta.pageCount` | integer |  |
| `meta.limit` | integer |  |
| `meta.isDone` | boolean |  |
| `meta.hasMore` | boolean |  |
| `meta.nextCursor` | string or null |  |
| `meta.asOf` | string (date-time) |  |
| `meta.page` | `PublicPageMeta` |  |
| `meta.status` | null or `AutomationStatus` |  |
| `links` | `PublicCollectionLinks` |  |
| `links.self` | string |  |
| `links.next` | string or null |  |