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

# List Playbooks

`GET /api/v1/playbooks`

## Request

- Base URL: `https://api.badgeia.com`
- URL: `https://api.badgeia.com/api/v1/playbooks`
- Auth: none declared

List only playbooks owned by the authenticated user.

## Query parameters

- `agent_id` string, uuid, nullable
- `active_only` boolean
- `page` integer
- `page_size` integer

## Response `200`

Successful Response

- PaginatedResponsePlaybookRead
  - `items` PlaybookRead[], required
    - `id` string, uuid, required
    - `agent_id` string, uuid, required
    - `name` string, required
    - `version` integer, required
    - `parent_id` string, uuid, nullable, required
    - `is_active` boolean, required
    - `is_default` boolean, required
    - `is_public` boolean, required
    - `playbook_type` string, required
    - `system_prompt` string, nullable, required
    - `model` string, required
    - `temperature` number, required
    - `max_tokens` integer, required
    - `top_p` number, required
    - `few_shot_examples` object[], nullable, required
    - `tools_config` object, nullable, required
    - `notes` string, nullable, required
    - `description` string, nullable
    - `created_at` string, date-time, required
    - `pricing_model` string
    - `price_usd_cents` integer
    - `total_clones` integer
    - `total_revenue_usd_cents` integer
    - `already_hired` boolean
  - `total` integer, required
  - `page` integer, required
  - `page_size` integer, required
  - `pages` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/badgeia/apis/badge.md) · [All operations](https://skmtc.dev/badgeia/apis/badge/llms.txt) · [OpenAPI document](https://skmtc.dev/badgeia/apis/badge/revisions/7e7f7fee8b77?raw)