> 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 active playbooks available in a space GET https://api.cloudraker.com/spaces/{spaceId}/playbooks Lists the ACTIVE playbook definitions launchable in this space, i.e. whose spaceTypes include the space's spaceType (resolved server-side from the space record — the caller never passes it). These are the playbooks a user can start as a run here. Authorization: requires `space:read` on the space (org admins bypass); callers without it get 404 (existence is hidden). 404 is also returned when the space does not exist. Returns `{ data: Playbook[] }` with no pagination; each Playbook carries its id, name, description, tasks and configured actions. Reference: https://docs.cloudraker.com/api/cloud-raker-api/workspace/playbooks/list-space-playbooks ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: CloudRaker API version: 1.0.0 paths: /spaces/{spaceId}/playbooks: get: operationId: list-space-playbooks summary: List active playbooks available in a space description: >- Lists the ACTIVE playbook definitions launchable in this space, i.e. whose spaceTypes include the space's spaceType (resolved server-side from the space record — the caller never passes it). These are the playbooks a user can start as a run here. Authorization: requires `space:read` on the space (org admins bypass); callers without it get 404 (existence is hidden). 404 is also returned when the space does not exist. Returns `{ data: Playbook[] }` with no pagination; each Playbook carries its id, name, description, tasks and configured actions. tags: - playbooks parameters: - name: spaceId in: path required: true schema: type: string - name: Authorization in: header description: Bearer authentication required: true schema: type: string responses: '200': description: Active playbooks launchable in this space. content: application/json: schema: $ref: '#/components/schemas/PlaybookList' '404': description: Space not found, or caller lacks space:read content: application/json: schema: description: Any type 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: 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 intake and review of new contracts.", "status": "active", "spaceTypes": [ "legal", "compliance" ], "tasks": [ { "id": "task-001", "title": "Review contract terms", "instructions": "Carefully review all contract terms and highlight any unusual clauses.", "dependsOn": [] }, { "id": "task-002", "title": "Verify signatures", "instructions": "Ensure all required parties have signed the contract.", "dependsOn": [ "task-001" ] } ], "actions": [ { "installedActionId": "action-verify-signature", "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/spaces/spaceId/playbooks" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.cloudraker.com/spaces/spaceId/playbooks'; const options = { method: 'GET', headers: {Authorization: 'Bearer ', '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/spaces/spaceId/playbooks" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("Authorization", "Bearer ") 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/spaces/spaceId/playbooks") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' 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 response = Unirest.get("https://api.cloudraker.com/spaces/spaceId/playbooks") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.cloudraker.com/spaces/spaceId/playbooks', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.cloudraker.com/spaces/spaceId/playbooks"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "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/spaces/spaceId/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() ```