---
title: "List installed playbook instances"
method: POST
path: "/api/v2/agent/listPlaybookInstances"
tags: ["Agent"]
---

# List installed playbook instances

`POST /api/v2/agent/listPlaybookInstances`

## Request

- Base URL: `https://zeropath.com`
- URL: `https://zeropath.com/api/v2/agent/listPlaybookInstances`
- Auth: API key in header `X-ZeroPath-API-Token-Id` and API key in header `X-ZeroPath-API-Token-Secret`

List every playbook instance (ACTIVE or PAUSED) installed for the organization. UNINSTALLED instances are excluded. Use this to answer questions about which automations are running, and to match an installed playbook to the matching PlaybookTemplate via `template.slug`.

## Request body

- AgentListPlaybookInstancesRequest
  - `organizationId` string: Organization ID (injected by MCP server)

## Response `200`

Installed playbook instances

- AgentListPlaybookInstancesResponse
  - `instances` object[], required
    - `id` string, uuid, required
    - `status` 'ACTIVE' | 'PAUSED', required: ACTIVE = running; PAUSED = installed but disabled. UNINSTALLED instances are not returned.
    - `parameterValues` object: User-provided parameter values for this instance (matches the template parameterSchema keys).
    - `modelStrength` 'LOW' | 'HIGH', required: Model strength used by this playbook activation and its generated triggers.
    - `conversationId` string, uuid, nullable: Conversation the playbook is running in (if any).
    - `activatedById` string, uuid, nullable: User who activated this playbook instance.
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `template` object, required
      - `slug` string, required: Stable identifier, e.g. "dependabot-replacement".
      - `name` string, required
      - `description` string, required
      - `category` 'SCA' | 'SAST' | 'CONTAINER' | 'INCIDENT_RESPONSE' | 'COMPLIANCE' | 'GENERAL', required

## Other responses

- `401`: Error Response

---

[API](https://skmtc.dev/zeropath/apis/zeropath-api.md) - [All operations](https://skmtc.dev/zeropath/apis/zeropath-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zeropath/apis/zeropath-api/revisions/126e9c80ba0d?raw)