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

# List playbooks

`GET /playbooks`

## Request

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

Retrieve playbooks for your organization.

## Query parameters

- `page` integer
- `page_size` integer
- `site_id` string, uuid

## Response `200`

Paginated list of playbooks

- object
  - `data` PlaybookSummary[]
    - `id` string, uuid
    - `name` string
    - `description` string, nullable
    - `steps` object[]
    - `step_count` integer
    - `estimated_minutes` integer, nullable
    - `is_system` boolean
    - `is_enabled` boolean
    - `created_at` string, date-time
  - `pagination` Pagination
    - `page` integer
    - `page_size` integer
    - `total` integer
    - `has_more` boolean

## Other responses

- `401`: Authentication failed
- `429`: Rate limit exceeded

---

[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)