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

# List playbooks

`GET /playbooks`

## Request

- Base URL: `https://app.gc.ai/api/external/v1`
- URL: `https://app.gc.ai/api/external/v1/playbooks`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/gc-ai/apis/gc-ai-external-api/docs/playbooks/get.ts> (a function with typed inputs; its response is checked against the schema)

List playbooks accessible to the caller.

With a user-scoped key, returns playbooks the user created, org-visible playbooks, shared playbooks, and official playbooks. With an org-scoped key, returns org-visible and official playbooks.

## Query parameters

- `limit` integer: Max items to return (default 100, max 500)
- `offset` integer, nullable: Number of items to skip (default 0)

## Response `200`

List of playbooks

- PlaybookListResponse
  - `playbooks` PlaybookSummary[], required
    - `id` string, uuid, required: Unique playbook identifier
    - `title` string, required: Playbook title
    - `description` string, nullable, required: Playbook description, or null if unset
    - `is_official` boolean, required: Whether this is an official GC AI playbook
    - `status` 'draft' | 'processing' | 'completed' | 'failed', required: Playbook processing status
    - `created_at` string, nullable, required: ISO 8601 creation timestamp
  - `pagination` Pagination, required
    - `limit` number, required: Page size
    - `offset` number, required: Current offset
    - `has_more` boolean, required: Whether more results exist

## Other responses

- `401`: Missing or malformed API key
- `403`: Invalid API key
- `429`: Rate limit exceeded. See [Rate Limits](https://docs.gc.ai/api-reference/concepts/rate-limits) for the tiers, limits, and how to back off.
- `500`: Internal server error
- `503`: Service temporarily unavailable

---

[API](https://skmtc.dev/gc-ai/apis/gc-ai-external-api.md) - [All operations](https://skmtc.dev/gc-ai/apis/gc-ai-external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gc-ai/apis/gc-ai-external-api/revisions/2bbdfddf7107?raw)