---
title: "Get a list of Channels"
method: GET
path: "/{spaceId}/channels/all"
tags: ["Channels"]
---

# Get a list of Channels

`GET /{spaceId}/channels/all`

## Request

- Base URL: `https://demo.octopus.app/api`
- URL: `https://demo.octopus.app/api/{spaceId}/channels/all`
- Auth: one of:
  - API key in header `X-Octopus-ApiKey`
  - API key in query parameter `ApiKey`
  - API key in header `X-NuGet-ApiKey`

Lists all of the channels in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.

## Path parameters

- `spaceId` string, required

## Query parameters

- `ids` string[]

## Response `200`

List of all of the channels in the supplied Octopus Deploy Space. The results will be sorted alphabetically by name.

- ChannelResource[]
  - `AutomaticEphemeralEnvironmentDeployments` boolean
  - `CustomFieldDefinitions` ChannelCustomFieldDefinitionResource[]
    - `Description` string
    - `FieldName` string
  - `Description` string
  - `EphemeralEnvironmentNameTemplate` string
  - `GitReferenceRules` string[]
  - `GitResourceRules` ChannelGitResourceRuleResource[]
    - `GitDependencyActions` DeploymentActionGitDependencyResource[]
      - `DeploymentActionSlug` string, required: The slug of the deployment action
      - `GitDependencyName` string, required: The name of the git dependency
    - `Id` string
    - `Rules` string[]
  - `Id` string: Gets or sets a unique identifier for this resource.
  - `IsDefault` 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.
  - `LifecycleId` 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
  - `ParentEnvironmentId` string: The parent environment for all ephemeral environments created in this channel.
  - `ProjectId` string
  - `Rules` ChannelVersionRuleResource[]
    - `ActionPackages` DeploymentActionPackageResource[]
      - `DeploymentAction` string: The name or ID of the deployment action
      - `PackageReference` string: The name or ID of the package reference
    - `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.
    - `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.
    - `Tag` string
    - `VersioningStrategy` string
    - `VersionRange` string
    - `VersionTagRegex` string
  - `Slug` string
  - `SpaceId` string
  - `TenantTags` string[]
  - `Type` string

## Other responses

- `304`: Not Modified
- `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.dev/octopus/apis/octopus-server-api.md) - [All operations](https://skmtc.dev/octopus/apis/octopus-server-api/llms.txt) - [OpenAPI document](https://skmtc.dev/octopus/apis/octopus-server-api/revisions/fe937c07da34?raw)