> 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 playbooks with their binding to a space type GET https://api.cloudraker.com/space-types/{spaceTypeId}/playbooks Admin configuration view of the playbook ↔ space-type binding: returns EVERY playbook definition in the org annotated for the space type named in the path. Each entry carries the playbook id, name, description, status and spaceTypes plus two flags: `bound` (its `spaceTypes` explicitly includes this space type) and `global` (its `spaceTypes` is empty, so it applies to every space type and cannot be unbound here). Authorization: org admin only — other callers get 403. Returns 404 `not_found` if the space type does not exist. Response: `{ data: [...] }`, unpaginated. Reference: https://docs.cloudraker.com/api/cloud-raker-api/workspace/playbooks/list-space-type-playbooks ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: CloudRaker API version: 1.0.0 paths: /space-types/{spaceTypeId}/playbooks: get: operationId: list-space-type-playbooks summary: List playbooks with their binding to a space type description: >- Admin configuration view of the playbook ↔ space-type binding: returns EVERY playbook definition in the org annotated for the space type named in the path. Each entry carries the playbook id, name, description, status and spaceTypes plus two flags: `bound` (its `spaceTypes` explicitly includes this space type) and `global` (its `spaceTypes` is empty, so it applies to every space type and cannot be unbound here). Authorization: org admin only — other callers get 403. Returns 404 `not_found` if the space type does not exist. Response: `{ data: [...] }`, unpaginated. tags: - playbooks parameters: - name: spaceTypeId in: path required: true schema: type: string - name: Authorization in: header description: Bearer authentication required: true schema: type: string responses: '200': description: Every playbook, annotated for this space type. content: application/json: schema: $ref: '#/components/schemas/SpaceTypePlaybookList' '404': description: '`not_found` — the space type does not exist' 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: SpaceTypePlaybookStatus: type: string enum: - draft - active - archived title: SpaceTypePlaybookStatus SpaceTypePlaybook: type: object properties: id: type: string name: type: string description: type: string status: $ref: '#/components/schemas/SpaceTypePlaybookStatus' spaceTypes: type: array items: type: string bound: type: boolean description: Its `spaceTypes` explicitly includes this type. global: type: boolean description: >- Its `spaceTypes` is empty, so it applies everywhere and cannot be unbound here. required: - id - name - description - status - spaceTypes - bound - global title: SpaceTypePlaybook SpaceTypePlaybookList: type: object properties: data: type: array items: $ref: '#/components/schemas/SpaceTypePlaybook' required: - data title: SpaceTypePlaybookList securitySchemes: bearerAuth: type: http scheme: bearer ``` ## Examples **Request** ```json {} ``` **Response** ```json { "data": [ { "id": "pbk-9f8a7c6d-1234-4e56-b789-0a1b2c3d4e5f", "name": "Incident Response Playbook", "description": "Steps to follow for handling security incidents in the workspace.", "status": "active", "spaceTypes": [ "security-workspace" ], "bound": true, "global": false }, { "id": "pbk-4d3c2b1a-9876-5f43-e210-9a8b7c6d5e4f", "name": "Company-wide Onboarding", "description": "Standard onboarding process applicable to all space types.", "status": "active", "spaceTypes": [], "bound": false, "global": true }, { "id": "pbk-7e6f5d4c-3210-4b98-a765-1c2d3e4f5a6b", "name": "Project Kickoff", "description": "Checklist and tasks for starting new projects in project spaces.", "status": "draft", "spaceTypes": [ "project-space", "development-space" ], "bound": false, "global": false } ] } ``` **SDK Code** ```python import requests url = "https://api.cloudraker.com/space-types/spaceTypeId/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/space-types/spaceTypeId/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/space-types/spaceTypeId/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/space-types/spaceTypeId/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/space-types/spaceTypeId/playbooks") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.cloudraker.com/space-types/spaceTypeId/playbooks', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.cloudraker.com/space-types/spaceTypeId/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/space-types/spaceTypeId/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() ```