---
title: "List Playbooks"
method: GET
path: "/v1/playbooks"
tags: ["playbooks"]
---

# List Playbooks

`GET /v1/playbooks`

List automations (playbooks) in the workspace.

Requires the `sequences:read` scope on the API key.

## Query parameters

- `page` integer
- `size` integer
- `status` 'DRAFT' | 'ENABLED' | 'PAUSED'
- `search` string, nullable — Search playbooks by name substring.

## Response `200`

Successful Response

- PublicPaginationEnvelopePlaybookPublicOutput
  - `items` PlaybookPublicOutput[], required — Records on this page.
    - `id` string, uuid, required — Unique identifier of the playbook.
    - `name` string, required — Name of the playbook.
    - `status` 'DRAFT' | 'ENABLED' | 'PAUSED', required
    - `trigger_type` 'SIGNAL' | 'SCHEDULE' | 'EVENT' | 'INBOUND_REPLY' | 'MANUAL' | 'CSV', required
    - `run_stats` PlaybookRunStatsPublicOutput
      - `runs_last_7_days` integer, required — Total number of runs in the last 7 days.
      - `succeeded_last_7_days` integer, required — Number of succeeded runs in the last 7 days.
      - `failed_last_7_days` integer, required — Number of failed runs in the last 7 days.
      - `waiting_on_approval_last_7_days` integer, required — Number of runs waiting on approval in the last 7 days.
      - `prospects_enrolled_last_7_days` integer, required — Number of prospects enrolled in the last 7 days.
  - `total_count` integer, required — Total number of records matching the query.
  - `total_pages` integer, required — Total number of pages.
  - `has_more` boolean, required — Whether more pages remain after the current one.

---

[API](https://skmtc.net/topo/apis/topo-public-api.md) · [All operations](https://skmtc.net/topo/apis/topo-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/topo/topo-public-api/revisions/80f4fd40b75e/schema)