---
title: "List automations"
method: GET
path: "/automations"
tags: ["Automations"]
---

# List automations

`GET /automations`

## Request

- Base URL: `https://api.parley.so/v1`
- URL: `https://api.parley.so/v1/automations`
- Auth: HTTP bearer

List your automations, newest first by default, each with its next run and most recent run. Other people's automations aren't listed.

## Query parameters

- `search` string: Case-insensitive. Only automations whose name contains this text.
- `status` 'active' | 'paused': Only active automations, or only paused ones.
- `projectId` string: Only automations that run in this project.
- `createdSince` string: Only records created at or after this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.
- `createdBefore` string: Only records created before this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.
- `updatedSince` string: Only records last updated at or after this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.
- `updatedBefore` string: Only records last updated before this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.
- `sort` 'name' | '-name' | 'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt': Sort order: a field name, prefixed with - for descending. Defaults to -createdAt.
- `cursor` string: Opaque cursor from nextCursor. Pass the same filters and sort. Omit for the first page.
- `limit` integer: Maximum number of items to return.

## Response `200`

OK

- object
  - `data` AutomationSummary[], required
    - `id` string, required: The automation ID.
    - `name` string, required: The automation name.
    - `description` string, nullable, required: A short summary of what the automation does, or null.
    - `status` 'active' | 'paused', required: active: the automation runs when its triggers fire. paused: its triggers are on hold, and the automation only runs when someone starts a run.
    - `nextRunAt` string, date-time, nullable, required: When a trigger next starts a run, or null for an automation that is paused or has no scheduled trigger.
    - `project` ProjectRef, required: The project's type, ID, and name.
      - `type` 'project', required
      - `id` string, required: Its ID.
      - `name` string, required: The project name.
    - `lastRun` object, nullable, required: The most recent run, or null for an automation that has never run.
      - `id` string, required: The run ID.
      - `status` 'pending' | 'running' | 'succeeded' | 'failed' | 'canceled' | 'timed_out', required: pending: queued and not yet started. running: in progress. succeeded, failed, canceled, and timed_out are final.
      - `startedAt` string, date-time, nullable, required: When the run started.
      - `endedAt` string, date-time, nullable, required: When the run finished.
    - `createdAt` string, date-time, required: When the automation was created.
    - `updatedAt` string, date-time, required: When the automation or its triggers were last changed.
  - `nextCursor` string, nullable, required: Cursor for the next page, or null on the last page.

## Other responses

- `400`: The request was invalid. VALIDATION_FAILED, INVALID_CURSOR.
- `401`: Missing or invalid credentials. UNAUTHORIZED.
- `403`: You don't have permission. FORBIDDEN.
- `429`: Too many requests, or a usage limit was reached. TOO_MANY_REQUESTS.

---

[API](https://skmtc.dev/parley/apis/parley-api.md) - [All operations](https://skmtc.dev/parley/apis/parley-api/llms.txt) - [OpenAPI document](https://skmtc.dev/parley/apis/parley-api/revisions/6b78aeee07bc?raw)