---
title: "List a playbook's runs"
method: GET
path: "/playbooks/{id}/runs"
tags: ["Playbooks"]
---

# List a playbook's runs

`GET /playbooks/{id}/runs`

## Request

- Base URL: `https://next.frase.io/api/v1`
- URL: `https://next.frase.io/api/v1/playbooks/{id}/runs`
- Auth: API key in header `X-API-KEY`

Retrieve runs for a playbook, most recent first.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `page` integer
- `page_size` integer

## Response `200`

List of playbook runs

- object
  - `data` object[]
    - `id` string, uuid
    - `playbook_id` string, uuid
    - `status` 'pending' | 'running' | 'paused' | 'completed' | 'failed' | 'cancelled'
    - `topic` string, nullable
    - `current_step_index` integer, nullable
    - `current_step_name` string, nullable: The name this run stored for the current step position, resilient to later edits of the playbook definition.
    - `started_at` string, date-time, nullable
    - `completed_at` string, date-time, nullable
    - `paused_at` string, date-time, nullable
    - `error` string, nullable
  - `pagination` Pagination
    - `page` integer
    - `page_size` integer
    - `total` integer
    - `has_more` boolean
  - `request_id` string

## Other responses

- `400`: Validation failed
- `401`: Authentication failed
- `429`: Rate limited, or the org's monthly brief limit blocked minting the refreshed brief (only the FIRST supersession of a brief is billing-exempt; repeats meter normally)

---

[API](https://skmtc.dev/frase/apis/frase-api.md) · [All operations](https://skmtc.dev/frase/apis/frase-api/llms.txt) · [OpenAPI document](https://skmtc.dev/frase/apis/frase-api/revisions/7fb75d89f7a4?raw)