> 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 runs in a space GET https://api.cloudraker.com/spaces/{spaceId}/playbook-runs Lists playbook runs in this space, newest first. Authorization: `space:read` (org admins bypass); missing → 404. Query params: `playbookId` (filter to one playbook), `status` (one of running, waiting_approval, waiting_action, waiting_user, paused, completed, failed, cancelled — an unrecognized value returns 400 `invalid_status`), `limit` (1–100), and `starting_after` (opaque cursor = the id of the last run from the previous page). Returns `{ data: PlaybookRun[], has_more }`; when `has_more` is true, page again using the last run id as `starting_after`. Reference: https://docs.cloudraker.com/api/cloud-raker-api/workspace/playbooks/list-playbook-runs ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: CloudRaker API version: 1.0.0 paths: /spaces/{spaceId}/playbook-runs: get: operationId: list-playbook-runs summary: List playbook runs in a space description: >- Lists playbook runs in this space, newest first. Authorization: `space:read` (org admins bypass); missing → 404. Query params: `playbookId` (filter to one playbook), `status` (one of running, waiting_approval, waiting_action, waiting_user, paused, completed, failed, cancelled — an unrecognized value returns 400 `invalid_status`), `limit` (1–100), and `starting_after` (opaque cursor = the id of the last run from the previous page). Returns `{ data: PlaybookRun[], has_more }`; when `has_more` is true, page again using the last run id as `starting_after`. tags: - playbooks parameters: - name: spaceId in: path required: true schema: type: string - name: playbookId in: query description: Only runs of this playbook. required: false schema: type: string - name: status in: query description: >- Run-status filter. An unrecognized value returns 400 `invalid_status`. required: false schema: $ref: '#/components/schemas/SpacesSpaceIdPlaybookRunsGetParametersStatus' - name: limit in: query description: Page size, 1–100. Defaults to 20. required: false schema: type: integer default: 20 - name: starting_after in: query description: 'Cursor: the id of the last run on the previous page.' required: false schema: type: string - name: Authorization in: header description: Bearer authentication required: true schema: type: string responses: '200': description: One page of playbook runs, newest first. content: application/json: schema: $ref: '#/components/schemas/PlaybookRunList' '400': description: Unrecognized status filter (invalid_status) 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: SpacesSpaceIdPlaybookRunsGetParametersStatus: type: string enum: - running - waiting_approval - waiting_action - waiting_user - paused - completed - failed - cancelled title: SpacesSpaceIdPlaybookRunsGetParametersStatus PlaybookRunStatus: type: string enum: - running - waiting_approval - waiting_action - waiting_user - paused - completed - failed - cancelled title: PlaybookRunStatus PlaybookFileScope0: type: object properties: mode: type: string enum: - space required: - mode title: PlaybookFileScope0 PlaybookFileScope1: type: object properties: mode: type: string enum: - picked fileIds: type: array items: type: string required: - mode - fileIds title: PlaybookFileScope1 PlaybookFileScope: oneOf: - $ref: '#/components/schemas/PlaybookFileScope0' - $ref: '#/components/schemas/PlaybookFileScope1' title: PlaybookFileScope PlaybookRunTaskProgress: type: object properties: total: type: integer completed: type: integer required: - total - completed title: PlaybookRunTaskProgress PlaybookRunPendingApprovalKind: type: string enum: - pre - post title: PlaybookRunPendingApprovalKind PlaybookRunPendingApproval: type: object properties: id: type: string kind: $ref: '#/components/schemas/PlaybookRunPendingApprovalKind' actionName: type: string requestedAt: type: string format: date-time required: - id - kind - actionName - requestedAt title: PlaybookRunPendingApproval PlaybookRun: type: object properties: id: type: string spaceId: type: string playbookId: type: string playbookVersion: type: integer playbookName: type: string status: $ref: '#/components/schemas/PlaybookRunStatus' fileScope: $ref: '#/components/schemas/PlaybookFileScope' taskProgress: $ref: '#/components/schemas/PlaybookRunTaskProgress' pendingApproval: oneOf: - $ref: '#/components/schemas/PlaybookRunPendingApproval' - type: 'null' result: type: - string - 'null' error: type: - string - 'null' startedBy: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time finishedAt: type: - string - 'null' format: date-time required: - id - spaceId - playbookId - playbookVersion - playbookName - status - fileScope - taskProgress - pendingApproval - result - error - startedBy - createdAt - updatedAt - finishedAt title: PlaybookRun PlaybookRunList: type: object properties: data: type: array items: $ref: '#/components/schemas/PlaybookRun' has_more: type: boolean required: - data - has_more title: PlaybookRunList securitySchemes: bearerAuth: type: http scheme: bearer ``` ## Examples **Request** ```json {} ``` **Response** ```json { "data": [ { "id": "run_8f3a2b7c9d4e", "spaceId": "space_12345", "playbookId": "pb_98765", "playbookVersion": 3, "playbookName": "Incident Response", "status": "running", "fileScope": { "mode": "space" }, "taskProgress": { "total": 12, "completed": 5 }, "pendingApproval": { "id": "approval_4567", "kind": "pre", "actionName": "Escalate to Tier 2", "requestedAt": "2024-01-15T09:30:00Z" }, "result": null, "error": null, "startedBy": "user_jdoe", "createdAt": "2024-01-15T08:45:00Z", "updatedAt": "2024-01-15T09:45:00Z", "finishedAt": null } ], "has_more": true } ``` **SDK Code** ```python import requests url = "https://api.cloudraker.com/spaces/spaceId/playbook-runs" 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/playbook-runs'; 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/playbook-runs" 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/playbook-runs") 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/playbook-runs") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.cloudraker.com/spaces/spaceId/playbook-runs', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.cloudraker.com/spaces/spaceId/playbook-runs"); 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/playbook-runs")! 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() ```