> 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 project playbooks

GET /api/projects/{projectId}/playbooks

Lists the playbooks scoped to a project, most recently updated first. Playbooks owned by a not-yet-approved brief are hidden. Optionally filter by status.

Reference: https://docs.cloudraker.com/api/raker-one-api/playbooks/get-projects-by-project-id-playbooks

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: RakerOne API
  version: 1.0.0
paths:
  /projects/{projectId}/playbooks:
    get:
      operationId: get-projects-by-project-id-playbooks
      summary: List project playbooks
      description: >-
        Lists the playbooks scoped to a project, most recently updated first.
        Playbooks owned by a not-yet-approved brief are hidden. Optionally
        filter by status.
      tags:
        - subpackage_playbooks
      parameters:
        - name: projectId
          in: path
          description: The project id.
          required: true
          schema:
            type: string
        - name: status
          in: query
          description: Filter to a single playbook status.
          required: false
          schema:
            $ref: '#/components/schemas/ProjectsProjectIdPlaybooksGetParametersStatus'
        - name: Authorization
          in: header
          description: >-
            WorkOS session JWT or an organization API key, sent as
            `Authorization: Bearer <token>`.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The project's playbooks.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaybookList'
        '401':
          description: Unauthorized — missing or invalid bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
servers:
  - url: /api
    description: Current origin
  - url: https://app.raker.one/api
    description: Production
components:
  schemas:
    ProjectsProjectIdPlaybooksGetParametersStatus:
      type: string
      enum:
        - draft
        - active
        - archived
      title: ProjectsProjectIdPlaybooksGetParametersStatus
    PlaybookScope:
      type: string
      enum:
        - library
        - template
        - project
      title: PlaybookScope
    PlaybookStatus:
      type: string
      enum:
        - draft
        - active
        - archived
      title: PlaybookStatus
    Playbook:
      type: object
      properties:
        _id:
          type: string
        scope:
          $ref: '#/components/schemas/PlaybookScope'
        templateId:
          type:
            - string
            - 'null'
        projectId:
          type:
            - string
            - 'null'
        sourceDefinitionId:
          type:
            - string
            - 'null'
        sourceVersion:
          type:
            - number
            - 'null'
          format: double
        slug:
          type: string
        name:
          type: string
        description:
          type: string
        icon:
          type: string
        color:
          type:
            - string
            - 'null'
        status:
          $ref: '#/components/schemas/PlaybookStatus'
        numbering:
          type: object
          additionalProperties:
            description: Any type
        startableByUsers:
          type: boolean
        webhookEnabled:
          type: boolean
        webhookSecret:
          type:
            - string
            - 'null'
        orchestrator:
          type: object
          additionalProperties:
            description: Any type
        startForm:
          type:
            - object
            - 'null'
          additionalProperties:
            description: Any type
        tasks:
          type: array
          items:
            type: object
            additionalProperties:
              description: Any type
        dependencies:
          type: array
          items:
            type: object
            additionalProperties:
              description: Any type
        version:
          type: number
          format: double
        archivedAt:
          type:
            - string
            - 'null'
        briefId:
          type:
            - string
            - 'null'
        createdAt:
          type: string
        updatedAt:
          type: string
        createdBy:
          type: string
      required:
        - _id
        - scope
        - templateId
        - projectId
        - sourceDefinitionId
        - sourceVersion
        - slug
        - name
        - description
        - icon
        - color
        - status
        - numbering
        - startableByUsers
        - webhookEnabled
        - webhookSecret
        - orchestrator
        - startForm
        - tasks
        - dependencies
        - version
        - archivedAt
        - briefId
        - createdAt
        - updatedAt
        - createdBy
      title: Playbook
    PlaybookList:
      type: object
      properties:
        playbooks:
          type: array
          items:
            $ref: '#/components/schemas/Playbook'
      required:
        - playbooks
      title: PlaybookList
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Machine-readable error code (e.g. `invalid_body`, `not_found`).
        issues:
          type: array
          items:
            description: Any type
          description: Schema-validation issues, present when `error` is `invalid_body`.
      required:
        - error
      description: Standard API error response.
      title: ErrorResponse
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        WorkOS session JWT or an organization API key, sent as `Authorization:
        Bearer <token>`.

```

## Examples



**Request**

```json
{}
```

**Response**

```json
{
  "playbooks": [
    {
      "_id": "5f8d0d55b54764421b7156c3",
      "scope": "library",
      "templateId": "tpl_9a8b7c6d5e4f3a2b1c0d",
      "projectId": "proj_1234567890abcdef",
      "sourceDefinitionId": "def_abcdef1234567890",
      "sourceVersion": 2.3,
      "slug": "customer-onboarding",
      "name": "Customer Onboarding",
      "description": "Playbook for onboarding new customers efficiently.",
      "icon": "📋",
      "color": "#4A90E2",
      "status": "draft",
      "numbering": {
        "step": "1.1"
      },
      "startableByUsers": true,
      "webhookEnabled": true,
      "webhookSecret": "whsec_4f3a2b1c0d9e8f7a",
      "orchestrator": {
        "type": "sequential",
        "retryPolicy": "exponential-backoff"
      },
      "startForm": {
        "fields": [
          {
            "name": "customerName",
            "type": "text",
            "required": true
          },
          {
            "name": "startDate",
            "type": "date",
            "required": false
          }
        ]
      },
      "tasks": [
        {
          "taskId": "task_001",
          "name": "Send welcome email",
          "type": "email"
        }
      ],
      "dependencies": [
        {
          "dependencyId": "dep_123",
          "type": "approval"
        }
      ],
      "version": 1.1,
      "archivedAt": null,
      "briefId": "brief_7890abcdef123456",
      "createdAt": "2024-05-10T09:15:00Z",
      "updatedAt": "2024-06-01T14:45:00Z",
      "createdBy": "user_5a6b7c8d9e0f1a2b3c4d"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api/projects/projectId/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/projects/projectId/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/projects/projectId/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/projects/projectId/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/projects/projectId/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/projects/projectId/playbooks', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api/projects/projectId/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/projects/projectId/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()
```