---
title: "Gets a list of Runbook Runs"
method: GET
path: "/projects/{projectId}/runbookRuns"
tags: ["RunbookRuns"]
---

# Gets a list of Runbook Runs

`GET /projects/{projectId}/runbookRuns`

Lists all of the runbookRuns in the supplied Octopus Deploy Space, from projects, snapshots and environments accessible by the current user. The results will be sorted from most recent to least recent runbookRun.

## Path parameters

- `projectId` string, required

## Query parameters

- `environments` string[]
- `ids` string[]
- `partialName` string
- `projects` string[]
- `runbooks` string[]
- `skip` integer
- `take` integer
- `taskState` 'Queued' | 'Executing' | 'Failed' | 'Canceled' | 'TimedOut' | 'Success' | 'Cancelling'
- `tenants` string[]

## Response `200`

The requested list of Runbook Runs

- RunbookRunResourceCollection
  - `Id` string
  - `Items` RunbookRunResource[]
    - `ChangeRequestSettings` ChangeRequestSettings[]
      - `Type` 'ServiceNow' | 'JiraServiceManagement'
    - `Comments` string
    - `Created` string, date-time
    - `DebugMode` string
    - `DeployedBy` string
    - `DeployedById` string
    - `DeployedToMachineIds` string[]
    - `EnvironmentId` string, required
    - `ExcludedMachineIds` string[]
    - `ExcludedTargetTagIds` string[]
    - `ExecutionPlanLogContext` ExecutionPlanLogContext
      - `Steps` StepLogContext[], required
        - `CorrelationId` string, required
        - `Slug` string, required
    - `FailTargetDiscovery` boolean
    - `FailureEncountered` boolean
    - `ForcePackageDownload` boolean
    - `FormValues` object
    - `FrozenRunbookProcessId` string
    - `Id` string
    - `LastModifiedBy` string
    - `LastModifiedOn` string, date-time
    - `Links` object
    - `ManifestVariableSetId` string
    - `Name` string
    - `Priority` string
    - `ProjectId` string
    - `QueueTime` string, date-time
    - `QueueTimeExpiry` string, date-time
    - `RunbookId` string, required
    - `RunbookName` string
    - `RunbookSnapshotId` string, required
    - `SkipActions` string[]
    - `SpaceId` string
    - `SpecificMachineIds` string[]
    - `SpecificTargetTagIds` string[]
    - `TaskId` string
    - `TenantId` string
    - `TentacleRetentionPeriod` RetentionPeriod
      - `QuantityToKeep` integer
      - `ShouldKeepForever` boolean
      - `Strategy` string
      - `Unit` 'Days' | 'Items'
    - `UseGuidedFailure` boolean
  - `ItemsPerPage` integer
  - `ItemType` string
  - `LastModifiedBy` string
  - `LastModifiedOn` string, date-time
  - `LastPageNumber` integer
  - `Links` object
  - `NumberOfPages` integer
  - `TotalResults` integer

## Other responses

- `400` — Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404` — Not found. One or more of the entities involved in the operation was not found.

---

[API](https://skmtc.net/octopus/apis/octopus-server-api.md) · [All operations](https://skmtc.net/octopus/apis/octopus-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/octopus/octopus-server-api/versions/bc9158facfc7/schema)