---
title: "List playbooks"
method: GET
path: "/v1/projects/{project_id}/playbooks"
tags: ["Playbooks"]
---

# List playbooks

`GET /v1/projects/{project_id}/playbooks`

## Request

- Base URL: `https://api.naturali.ai`
- URL: `https://api.naturali.ai/v1/projects/{project_id}/playbooks`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://api.naturali.ai/authorize`, token URL `https://api.naturali.ai/token`, scopes: `mcp:access`)

Returns the playbooks defined in a project, newest first.

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

List of playbooks

- object
  - `data` Playbook[], required
    - `id` string
    - `project_id` string
    - `name` string
    - `description` string, nullable
    - `version` integer: The definition's version. Bumped only by a write that changes `definition`.
    - `definition` PlaybookDefinition
      - `nodes` PlaybookNode[], required
        - `id` string, required: Stable across versions: a case's values carry over by ID. Letters, digits and underscores, starting with a letter or underscore.
        - `title` string, required
        - `description` string
        - `kind` 'collect' | 'execute' | 'confirm', required: `collect` outputs its inputs, `execute` runs its executor, `confirm` waits for a person to confirm its inputs.
        - `final` boolean: A goal of the playbook; only a final node carries transformations
        - `inputs` PlaybookInput[], required
          - `name` string, required: Letters, digits and underscores, starting with a letter or underscore
          - `schema` object, required: The JSON Schema a value must satisfy
          - `required` boolean, required: The node cannot run until a required input is set
          - `description` string: What to ask for; shown with the input when it is missing
          - `source` union, required: `manual` for an input a person or an integration writes, or the field of an earlier node it reads: `output[.path]`, or `input.<name>[.path]`. Sources are the playbook's edges.
            - 'manual'
            - object
              - …
        - `executor` PlaybookExecutor
          - `type` 'agent' | 'tool' | 'decider' | 'workflow' | 'orchestration', required
          - `id` string, required: The ID of the agent, tool, decider, workflow or orchestration
          - `input` object: JSON Logic over the node's inputs, as an orchestration's `input_mapping`: each key is a field of the executor's input. Absent, the executor receives the node's input values as they are.
        - `transformations` PlaybookTransformation[]
          - `name` string, required
          - `format` 'csv' | 'docx' | 'html' | 'jpg' | 'json' | 'md' | 'pdf' | 'png' | 'pptx' | 'txt' | 'xlsx', required: The file's format; the tool must answer its content type: `application/pdf` for `pdf`, the Office Open XML types for `docx`, `xlsx` and `pptx`, `text/csv`, `text/html`, `text/markdown`, `text/plain`, `application/json`, `image/png` and `image/jpeg` for `jpg`
          - `tool` string, required: The tool that renders the final node's output as a file, answering with `execute.response_mode: base64`
    - `created_at` string, date-time
    - `updated_at` string, date-time
  - `total` integer, required
  - `limit` integer, required
  - `offset` integer, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden

---

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