---
title: "List playbooks"
method: GET
path: "/api/workspaces/{workspaceId}/playbooks"
tags: ["Playbooks"]
---

# List playbooks

`GET /api/workspaces/{workspaceId}/playbooks`

## Request

- Base URL: `https://hiveship.app/api`
- URL: `https://hiveship.app/api/api/workspaces/{workspaceId}/playbooks`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `hiveship_access`

`?summary=1` omits each row's content body (cheap discovery for the list tool). `?name=` returns just the one playbook matching that name (case-insensitive), full body.

## Path parameters

- `workspaceId` string, required

## Query parameters

- `summary` string: Set to 1 to omit the content body from each row (cheap discovery).
- `name` string: Filter to a single playbook by exact name (case-insensitive), with its full body.

## Response `200`

List of playbooks

- object
  - `success` boolean, required
  - `data` object[], required
    - `id` string, cuid, required
    - `workspaceId` string, cuid, required
    - `name` string, required
    - `triggerHint` string, nullable, required
    - `content` string
    - `version` integer, required
    - `createdAt` string, required
    - `updatedAt` string, required

---

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