---
title: "Get a list of Runbook Processes"
method: GET
path: "/runbookProcesses"
tags: ["RunbookProcesses"]
---

# Get a list of Runbook Processes

`GET /runbookProcesses`

## Query parameters

- `skip` integer
- `take` integer

## Response `200`

Returns the Runbook Processes

- RunbookProcessResourceCollection
  - `Id` string — Gets or sets a unique identifier for this resource.
  - `Items` RunbookProcessResource[]
    - `Id` string — Gets or sets a unique identifier for this resource.
    - `LastModifiedBy` string — Gets or sets the username of the user who last modified this resource.
    - `LastModifiedOn` string, date-time — Gets or sets the date/time that this resource was last modified.
    - `LastSnapshotId` string
    - `Links` object — Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
    - `ProjectId` string
    - `RunbookId` string
    - `SpaceId` string
    - `Steps` DeploymentStepResource[]
      - `Actions` DeploymentActionResource[]
        - `ActionType` string
        - `AvailableStepPackageVersions` string[]
        - `CanBeUsedForProjectVersioning` boolean
        - `Channels` string[]
        - `ChannelsVariable` string
        - `CommunityActionTemplateSnapshot` CommunityActionTemplateSnapshotResource
          - `Id` string
          - `Parameters` ActionTemplateParameterResource[]
            - `DefaultValue` PropertyValueResource
              - …
            - `DisplaySettings` object
            - `HelpText` string
            - `Id` string
            - `Label` string
            - `Name` string
          - `Version` integer
        - `Condition` 'Success' | 'Variable'
        - `Container` DeploymentActionContainerResource
          - `Dockerfile` string
          - `FeedId` string
          - `GitUrl` string
          - `Image` string
        - `Environments` string[]
        - `EnvironmentsVariable` string
        - `ExcludedEnvironments` string[]
        - `ExcludedEnvironmentsVariable` string
        - `GitDependencies` GitDependencyResource[]
          - `DefaultBranch` string, required
          - `FilePathFilters` string[]
          - `GitCredentialId` string
          - `GitCredentialType` string, required
          - `GitHubConnectionId` string
          - `Name` string, required
          - `RepositoryUri` string, required
          - `StepPackageInputsReferenceId` string
        - `Id` string — Gets or sets a unique identifier for this resource.
        - `Inputs` StepPackageInputsResource
          - `Value` unknown
        - `IsDisabled` boolean
        - `IsRequired` boolean
        - `LastModifiedBy` string — Gets or sets the username of the user who last modified this resource.
        - `LastModifiedOn` string, date-time — Gets or sets the date/time that this resource was last modified.
        - `LastSavedStepPackageVersion` string
        - `Links` object — Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
        - `Name` string
        - `Notes` string
        - `Packages` PackageReferenceResource[]
          - `AcquisitionLocation` string — The package-acquisition location. One of PackageAcquisitionLocationResource or a variable-expression
          - `FeedId` string — Feed ID, name or a variable-expression
          - `Id` string
          - `Name` string — A name for the package-reference. This may be empty. This is used to discriminate the package-references. Package ID isn't suitable because an action may potentially have multiple references to the same package ID (e.g. if you wanted to use different versions of the same package). Also, the package ID may be a variable-expression.
          - `PackageId` string — Package ID or a variable-expression
          - `Properties` object
          - `StepPackageInputsReferenceId` string — This reference identifier is populated when a step package step contains a package reference It allows us to correlate the reference within the step package inputs to this Server package reference
          - `Version` string — Specific version to use for this package. If not specified, package can be selected at release creation or runbook run time.
        - `Properties` object
        - `Slug` string
        - `StepPackageVersion` string
        - `TenantTags` string[]
        - `TenantTagsVariable` string
        - `WorkerPoolId` string
        - `WorkerPoolVariable` string
      - `Condition` 'Success' | 'Failure' | 'Always' | 'Variable'
      - `Id` string
      - `Name` string, required
      - `PackageRequirement` 'LetOctopusDecide' | 'BeforePackageAcquisition' | 'AfterPackageAcquisition'
      - `Properties` object
      - `Slug` string
      - `StartTrigger` 'StartAfterPrevious' | 'StartWithPrevious'
      - `Type` string — Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
    - `Version` integer, required
  - `ItemsPerPage` integer
  - `ItemType` string
  - `LastModifiedBy` string — Gets or sets the username of the user who last modified this resource.
  - `LastModifiedOn` string, date-time — Gets or sets the date/time that this resource was last modified.
  - `LastPageNumber` integer
  - `Links` object — Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  - `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/revisions/b296c3a60aa5/schema)