---
title: "List all subscriptions"
method: GET
path: "/v1/projects/{projectID}/subscriptions"
tags: ["Subscriptions"]
---

# List all subscriptions

`GET /v1/projects/{projectID}/subscriptions`

This endpoint fetches all the subscriptions

## Path parameters

- `projectID` string, required

## Query parameters

- `direction` 'next' | 'prev'
- `endpointId` string[]
- `next_page_cursor` string
- `perPage` integer
- `prev_page_cursor` string
- `sort` string

## Response `200`

OK

- object
  - `message` string
  - `status` boolean
  - `data` object
    - `content` ModelsSubscriptionResponse[]
      - `alert_config` DatastoreAlertConfiguration
        - `count` integer
        - `threshold` string
      - `created_at` string
      - `deleted_at` string
      - `device_metadata` DatastoreDevice
        - `created_at` string
        - `deleted_at` string
        - `endpoint_id` string
        - `host_name` string
        - `last_seen_at` string
        - `project_id` string
        - `status` 'offline' | 'online' | 'disabled'
        - `uid` string
        - `updated_at` string
      - `endpoint_metadata` DatastoreEndpoint
        - `advanced_signatures` boolean
        - `authentication` DatastoreEndpointAuthentication
          - `api_key` DatastoreApiKey
            - `header_name` string
            - `header_value` string
          - `type` 'api_key'
        - `created_at` string
        - `deleted_at` string
        - `description` string
        - `events` integer
        - `http_timeout` integer
        - `name` string
        - `owner_id` string
        - `project_id` string
        - `rate_limit` integer
        - `rate_limit_duration` integer
        - `secrets` DatastoreSecret[]
          - `created_at` string
          - `deleted_at` string
          - `expires_at` string
          - `uid` string
          - `updated_at` string
          - `value` string
        - `slack_webhook_url` string
        - `status` 'active' | 'inactive' | 'pending' | 'paused'
        - `support_email` string
        - `uid` string
        - `updated_at` string
        - `url` string
      - `filter_config` DatastoreFilterConfiguration
        - `event_types` string[]
        - `filter` DatastoreFilterSchema
          - `body` DatastoreM
          - `headers` DatastoreM
      - `function` NullString
        - `string` string
        - `valid` boolean — Valid is true if String is not NULL
      - `name` string
      - `rate_limit_config` DatastoreRateLimitConfiguration
        - `count` integer
        - `duration` integer
      - `retry_config` DatastoreRetryConfiguration
        - `duration` integer
        - `retry_count` integer
        - `type` 'linear' | 'exponential'
      - `source_metadata` DatastoreSource
        - `created_at` string
        - `custom_response` DatastoreCustomResponse
          - `body` string
          - `content_type` string
        - `deleted_at` string
        - `forward_headers` string[]
        - `idempotency_keys` string[]
        - `is_disabled` boolean
        - `mask_id` string
        - `name` string
        - `project_id` string
        - `provider` 'github' | 'twitter' | 'shopify'
        - `provider_config` DatastoreProviderConfig
          - `twitter` DatastoreTwitterProviderConfig
            - `crc_verified_at` string
        - `pub_sub` DatastorePubSubConfig
          - `amqp` DatastoreAmqpPubSubConfig
            - `auth` DatastoreAmqpCredentials
              - …
            - `bindedExchange` string
            - `deadLetterExchange` string
            - `host` string
            - `port` string
            - `queue` string
            - `routingKey` string
            - `schema` string
          - `google` DatastoreGooglePubSubConfig
            - `project_id` string
            - `service_account` integer[]
            - `subscription_id` string
          - `kafka` DatastoreKafkaPubSubConfig
            - `auth` DatastoreKafkaAuth
              - …
            - `brokers` string[]
            - `consumer_group_id` string
            - `topic_name` string
          - `sqs` DatastoreSQSPubSubConfig
            - `access_key_id` string
            - `default_region` string
            - `queue_name` string
            - `secret_key` string
          - `type` 'sqs' | 'google' | 'kafka' | 'amqp'
          - `workers` integer
        - `type` 'http' | 'rest_api' | 'pub_sub' | 'db_change_stream'
        - `uid` string
        - `updated_at` string
        - `url` string
        - `verifier` DatastoreVerifierConfig
          - `api_key` DatastoreApiKey
            - `header_name` string
            - `header_value` string
          - `basic_auth` DatastoreBasicAuth
            - `password` string
            - `username` string
          - `hmac` DatastoreHMac
            - `encoding` 'base64' | 'hex'
            - `hash` string
            - `header` string
            - `secret` string
          - `type` 'noop' | 'hmac' | 'basic_auth' | 'api_key'
      - `type` 'cli' | 'api'
      - `uid` string
      - `updated_at` string
    - `pagination` DatastorePaginationData
      - `has_next_page` boolean
      - `has_prev_page` boolean
      - `next_page_cursor` string
      - `per_page` integer
      - `prev_page_cursor` string

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found

## Changes

- **2024-03-26** (v3) `28d285e4302c` — 6 warning, 3 info
  - removed the optional property `allOf[#/components/schemas/util.ServerResponse]/data` from the response with the `200` status
  - removed the optional property `allOf[#/components/schemas/util.ServerResponse]/data` from the response with the `400` status
  - removed the optional property `allOf[#/components/schemas/util.ServerResponse]/data` from the response with the `401` status
  - removed the optional property `allOf[#/components/schemas/util.ServerResponse]/data` from the response with the `404` status
  - …5 more
- **2024-02-20** (v3) `6ef49682c1c0` — 1 info
  - added the new optional `query` request parameter `direction`
- **2024-02-20** (v3) `81dc59314306` — 1 warning
  - deleted the `query` request parameter `direction`
- **2024-02-08** (v3) `8aa5161aec4c` — 1 warning, 1 info
  - added the new `amqp` enum value to the `allOf[subschema #2]/data/allOf[subschema #2]/content/items/source_metadata/pub_sub/type` response property for the response status `200`
  - added the optional property `allOf[subschema #2]/data/allOf[subschema #2]/content/items/source_metadata/pub_sub/amqp` to the response with the `200` status
- **2024-02-08** (v3) `52443da83eda` — 1 info
  - added the new optional `query` request parameter `direction`

[Full history](https://skmtc.dev/getconvoy/apis/convoy-api-reference/changes/v1/projects/:projectID/subscriptions/get.md)

---

[API](https://skmtc.dev/getconvoy/apis/convoy-api-reference.md) · [All operations](https://skmtc.dev/getconvoy/apis/convoy-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getconvoy/convoy-api-reference/revisions/28d285e4302c/schema)
