---
title: "Get Playbook"
method: GET
path: "/v1/playbooks/{playbook_id}"
tags: ["playbooks"]
---

# Get Playbook

`GET /v1/playbooks/{playbook_id}`

## Request

- Base URL: `https://api.topo.io`
- URL: `https://api.topo.io/v1/playbooks/{playbook_id}`
- Auth: HTTP bearer

Fetch a single playbook configuration and run stats.

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

## Path parameters

- `playbook_id` string, uuid, required

## Response `200`

Successful Response

- PlaybookPublicOutput
  - `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' | 'LEAD_IMPORT_COMPLETED' | 'ACTIVITY', 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.

## Changes

- **2026-10-05** `3535956158d8`: 1 warning
  - added the new `ACTIVITY` enum value to the `trigger_type` response property for the response status `200`
- **2026-09-30** `793d8d4affc7`: 1 warning
  - added the new `LEAD_IMPORT_COMPLETED` enum value to the `trigger_type` response property for the response status `200`
- **2026-08-15** `80f4fd40b75e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/topo/apis/topo-public-api/changes/v1/playbooks/:playbook_id/get.md)

---

[API](https://skmtc.dev/topo/apis/topo-public-api.md) · [All operations](https://skmtc.dev/topo/apis/topo-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/topo/apis/topo-public-api/revisions/62914910b2a8?raw)