---
title: "Get a list of Runbooks"
method: GET
path: "/{spaceId}/runbooks"
tags: ["Runbooks"]
---

# Get a list of Runbooks

`GET /{spaceId}/runbooks`

Gets a paginated list of the Runbooks in the supplied Octopus Deploy Space (sorted by name).

## Path parameters

- `spaceId` string, required

## Query parameters

- `ids` string[]
- `partialName` string
- `skip` integer
- `take` integer

## Response `200`

A paginated list of the Runbooks in the supplied Octopus Deploy Space (sorted by name).

- RunbookResourceCollection
  - `Id` string
  - `Items` RunbookResource[]
    - `CancelQueuedTasks` boolean
    - `CancelRunningTasks` boolean
    - `ConnectivityPolicy` DeploymentConnectivityPolicy
      - `AllowDeploymentsToNoTargets` boolean
      - `ExcludeUnhealthyTargets` boolean
      - `SkipMachineBehavior` 'None' | 'SkipUnavailableMachines'
      - `TargetRoles` string[]
    - `DefaultGuidedFailureMode` 'EnvironmentDefault' | 'Off' | 'On'
    - `Description` string
    - `Environments` string[]
    - `EnvironmentScope` 'All' | 'Specified' | 'FromProjectLifecycles'
    - `FailTargetDiscovery` boolean
    - `ForcePackageDownload` boolean
    - `Id` string
    - `LastModifiedBy` string
    - `LastModifiedOn` string, date-time
    - `Links` object
    - `MultiTenancyMode` 'Untenanted' | 'TenantedOrUntenanted' | 'Tenanted'
    - `Name` string
    - `ProjectId` string
    - `PublishedRunbookSnapshotId` string
    - `RunbookProcessId` string
    - `RunbookTags` string[]
    - `RunRetentionPolicy` RunbookRetentionPolicy
      - `QuantityToKeep` integer
      - `ShouldKeepForever` boolean
      - `Strategy` string
      - `Unit` 'Days' | 'Items'
    - `Slug` string
    - `SpaceId` string
  - `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)