> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.cloudraker.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cloudraker.com/_mcp/server.

# List playbook definitions

GET https://api.cloudraker.com/playbooks

Lists the org-level playbook definitions for the caller tenant. Authorization: any authenticated org member (session + tenant context only, no admin required). Optional query `status` filters by lifecycle state and MUST be one of `draft` | `active` | `archived` — any other value returns 400 `invalid_status`. Optional query `spaceType` filters to playbooks whose `spaceTypes` includes that space-type slug (playbooks with an empty `spaceTypes` apply to all space types). Response is `{ data: Playbook[] }` — a single unpaginated array; each Playbook carries id, name, description, status, spaceTypes, tasks, actions, version, createdAt/updatedAt, createdBy.

Reference: https://docs.cloudraker.com/api/cloud-raker-api/workspace/playbooks/list-playbooks

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: CloudRaker API
  version: 1.0.0
paths:
  /playbooks:
    get:
      operationId: list-playbooks
      summary: List playbook definitions
      description: >-
        Lists the org-level playbook definitions for the caller tenant.
        Authorization: any authenticated org member (session + tenant context
        only, no admin required). Optional query `status` filters by lifecycle
        state and MUST be one of `draft` | `active` | `archived` — any other
        value returns 400 `invalid_status`. Optional query `spaceType` filters
        to playbooks whose `spaceTypes` includes that space-type slug (playbooks
        with an empty `spaceTypes` apply to all space types). Response is `{
        data: Playbook[] }` — a single unpaginated array; each Playbook carries
        id, name, description, status, spaceTypes, tasks, actions, version,
        createdAt/updatedAt, createdBy.
      tags:
        - playbooks
      parameters:
        - name: status
          in: query
          description: >-
            Lifecycle filter: `draft`, `active` or `archived`. Any other value
            returns 400 `invalid_status`.
          required: false
          schema:
            $ref: '#/components/schemas/PlaybooksGetParametersStatus'
        - name: spaceType
          in: query
          description: >-
            Only playbooks whose `spaceTypes` includes this identifier.
            Playbooks with an empty `spaceTypes` apply everywhere.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: Bearer authentication
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The playbook definitions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaybookList'
servers:
  - url: https://api.cloudraker.com
    description: Production
  - url: https://api.staging.raker.one
    description: Staging
  - url: https://api.dev.raker.one
    description: Development
components:
  schemas:
    PlaybooksGetParametersStatus:
      type: string
      enum:
        - draft
        - active
        - archived
      title: PlaybooksGetParametersStatus
    PlaybookStatus:
      type: string
      enum:
        - draft
        - active
        - archived
      title: PlaybookStatus
    PlaybookTasksItems:
      type: object
      properties:
        id:
          type: string
        title:
          type: string
        instructions:
          type:
            - string
            - 'null'
        dependsOn:
          type: array
          items:
            type: string
          description: Task ids that must complete first.
      required:
        - id
        - title
        - instructions
        - dependsOn
      title: PlaybookTasksItems
    PlaybookActionsItemsTrigger:
      type: string
      enum:
        - agent
        - user
      description: >-
        `user` actions are started from the run view; the agent never proposes
        them.
      title: PlaybookActionsItemsTrigger
    PlaybookActionsItems:
      type: object
      properties:
        installedActionId:
          type: string
        preApproval:
          type: boolean
          description: Gate the action behind a human approval.
        postApproval:
          type: boolean
          description: Review the action output before continuing.
        dependsOn:
          type: array
          items:
            type: string
          description: Task ids only — an action may never depend on another action.
        trigger:
          $ref: '#/components/schemas/PlaybookActionsItemsTrigger'
          description: >-
            `user` actions are started from the run view; the agent never
            proposes them.
      required:
        - installedActionId
        - preApproval
        - postApproval
        - dependsOn
        - trigger
      title: PlaybookActionsItems
    Playbook:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        status:
          $ref: '#/components/schemas/PlaybookStatus'
        spaceTypes:
          type: array
          items:
            type: string
          description: >-
            Space-type identifiers this playbook applies to. Empty means every
            space type.
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/PlaybookTasksItems'
        actions:
          type: array
          items:
            $ref: '#/components/schemas/PlaybookActionsItems'
        version:
          type: integer
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        createdBy:
          type: string
      required:
        - id
        - name
        - description
        - status
        - spaceTypes
        - tasks
        - actions
        - version
        - createdAt
        - updatedAt
        - createdBy
      title: Playbook
    PlaybookList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Playbook'
      required:
        - data
      title: PlaybookList
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

```

## Examples



**Request**

```json
{}
```

**Response**

```json
{
  "data": [
    {
      "id": "pb-8f3a2c1d",
      "name": "Contract intake",
      "description": "A playbook to guide the contract intake process ensuring all necessary steps are completed.",
      "status": "draft",
      "spaceTypes": [
        "legal",
        "sales"
      ],
      "tasks": [
        {
          "id": "task-001",
          "title": "Review contract details",
          "instructions": "Carefully review the contract terms and conditions for compliance and completeness.",
          "dependsOn": []
        },
        {
          "id": "task-002",
          "title": "Obtain initial approvals",
          "instructions": "Get approval from the legal and sales departments before proceeding.",
          "dependsOn": [
            "task-001"
          ]
        }
      ],
      "actions": [
        {
          "installedActionId": "action-verify-signature",
          "preApproval": true,
          "postApproval": false,
          "dependsOn": [
            "task-002"
          ],
          "trigger": "agent"
        },
        {
          "installedActionId": "action-notify-team",
          "preApproval": false,
          "postApproval": true,
          "dependsOn": [
            "task-002"
          ],
          "trigger": "user"
        }
      ],
      "version": 3,
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-04-10T14:45:00Z",
      "createdBy": "jane.doe@cloudraker.com"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.cloudraker.com/playbooks"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.cloudraker.com/playbooks';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloudraker.com/playbooks"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.cloudraker.com/playbooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.cloudraker.com/playbooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.cloudraker.com/playbooks', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.cloudraker.com/playbooks");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.cloudraker.com/playbooks")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```