---
title: "Get a list of Subscriptions"
method: GET
path: "/subscriptions"
tags: ["Subscriptions"]
---

# Get a list of Subscriptions

`GET /subscriptions`

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

## Query parameters

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

## Response `200`

The requested Subscriptions

- SubscriptionResourceCollection
  - `Id` string
  - `Items` SubscriptionResource[]
    - `EventNotificationSubscription` EventNotificationSubscriptionResource
      - `EmailDigestLastProcessed` string, date-time
      - `EmailDigestLastProcessedEventAutoId` integer
      - `EmailFrequencyPeriod` string, date-span
      - `EmailPriority` 'Normal' | 'Low' | 'High'
      - `EmailShowDatesInTimeZoneId` string
      - `EmailTeams` string[]
      - `Filter` EventNotificationSubscriptionFilterResource
        - `DocumentTypes` string[]
        - `Environments` string[]
        - `EventAgents` string[]
        - `EventCategories` string[]
        - `EventGroups` string[]
        - `ProjectGroups` string[]
        - `Projects` string[]
        - `Tags` string[]
        - `Tenants` string[]
        - `Users` string[]
      - `SlackChannelIds` string[]
      - `SlackChannelNames` string[]
      - `SlackDigestLastProcessed` string, date-time
      - `SlackDigestLastProcessedEventAutoId` integer
      - `SlackFrequencyPeriod` string, date-span
      - `WebhookHeaderKey` string
      - `WebhookHeaderValue` PropertyValueResource
        - `IsSensitive` boolean
        - `SensitiveValue` SensitiveValue
          - `HasValue` boolean
          - `Hint` string
          - `NewValue` string
        - `Value` string
      - `WebhookLastProcessed` string, date-time
      - `WebhookLastProcessedEventAutoId` integer
      - `WebhookTeams` string[]
      - `WebhookTimeout` string, date-span
      - `WebhookURI` string, uri
    - `Id` string
    - `IsDisabled` boolean
    - `LastModifiedBy` string
    - `LastModifiedOn` string, date-time
    - `Links` object
    - `Name` string
    - `SpaceId` string
    - `Type` 'Event'
  - `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)