> 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/workspace/api/playbooks/list-playbooks

## Authentication

- `Authorization` header (bearer token, required)

## Request

### Query parameters

- `status` (enum, optional) — Lifecycle filter: `draft`, `active` or `archived`. Any other value returns 400 `invalid_status`.
  - Allowed values: `draft`, `active`, `archived`
- `spaceType` (string, optional) — Only playbooks whose `spaceTypes` includes this identifier. Playbooks with an empty `spaceTypes` apply everywhere.

## Response

### 200

The playbook definitions.

- `data` (list of object, required)
  - `id` (string, required)
  - `name` (string, required)
  - `description` (string, required)
  - `status` (enum, required)
    - Allowed values: `draft`, `active`, `archived`
  - `spaceTypes` (list of string, required) — Space-type identifiers this playbook applies to. Empty means every space type.
  - `tasks` (list of object, required)
    - `id` (string, required)
    - `title` (string, required)
    - `instructions` (string, required, nullable)
    - `dependsOn` (list of string, required) — Task ids that must complete first.
    - `executor` (enum, required) — `human` tasks are completed by a person out-of-band; the agent never does them.
      - Allowed values: `agent`, `human`
    - `assignee` (string, required, nullable) — User id. Human tasks only; null = anyone in the space.
  - `actions` (list of object, required)
    - `installedActionId` (string, required)
    - `preApproval` (boolean, required) — Gate the action behind a human approval.
    - `postApproval` (boolean, required) — Review the action output before continuing.
    - `dependsOn` (list of string, required) — Task ids only — an action may never depend on another action.
    - `trigger` (enum, required) — `user` actions are started from the run view; the agent never proposes them.
      - Allowed values: `agent`, `user`
  - `model` (string, required, nullable) — Optional model override for agent runs. Validated against an allowlist.
  - `version` (integer, required)
  - `createdAt` (datetime, required)
  - `updatedAt` (datetime, required)
  - `createdBy` (string, required)

## Examples

**Response**

```json
{
  "data": [
    {
      "id": "string",
      "name": "Contract intake",
      "description": "string",
      "status": "draft",
      "spaceTypes": [
        "string"
      ],
      "tasks": [
        {
          "id": "string",
          "title": "string",
          "instructions": "string",
          "dependsOn": [
            "string"
          ],
          "executor": "agent",
          "assignee": "string"
        }
      ],
      "actions": [
        {
          "installedActionId": "string",
          "preApproval": true,
          "postApproval": true,
          "dependsOn": [
            "string"
          ],
          "trigger": "agent"
        }
      ],
      "model": "string",
      "version": 1,
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "createdBy": "string"
    }
  ]
}
```

**SDK Code**

```python
import requests

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

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

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

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"
	"net/http"
	"io"
)

func main() {

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

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

	req.Header.Add("Authorization", "Bearer <token>")

	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>'

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>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

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

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()
```