Skip to main content
GET
/
v1
/
projects
/
{projectID}
/
subscriptions
List all subscriptions
curl --request GET \
  --url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/subscriptions \
  --header 'Authorization: <api-key>'
{
  "message": "<string>",
  "status": true,
  "data": {
    "content": [
      {
        "alert_config": {
          "count": 123,
          "threshold": "<string>"
        },
        "created_at": "<string>",
        "deleted_at": "<string>",
        "device_metadata": {
          "created_at": "<string>",
          "deleted_at": "<string>",
          "endpoint_id": "<string>",
          "host_name": "<string>",
          "last_seen_at": "<string>",
          "project_id": "<string>",
          "status": "offline",
          "uid": "<string>",
          "updated_at": "<string>"
        },
        "endpoint_metadata": {
          "advanced_signatures": true,
          "authentication": {
            "api_key": {
              "header_name": "<string>",
              "header_value": "<string>"
            },
            "type": "api_key"
          },
          "created_at": "<string>",
          "deleted_at": "<string>",
          "description": "<string>",
          "events": 123,
          "failure_rate": 123,
          "http_timeout": 123,
          "name": "<string>",
          "owner_id": "<string>",
          "project_id": "<string>",
          "rate_limit": 123,
          "rate_limit_duration": 123,
          "secrets": [
            {
              "created_at": "<string>",
              "deleted_at": "<string>",
              "expires_at": "<string>",
              "uid": "<string>",
              "updated_at": "<string>",
              "value": "<string>"
            }
          ],
          "slack_webhook_url": "<string>",
          "status": "active",
          "support_email": "<string>",
          "uid": "<string>",
          "updated_at": "<string>",
          "url": "<string>"
        },
        "filter_config": {
          "event_types": [
            "<string>"
          ],
          "filter": {
            "body": {},
            "headers": {},
            "is_flattened": true
          }
        },
        "function": "<string>",
        "name": "<string>",
        "project_id": "<string>",
        "rate_limit_config": {
          "count": 123,
          "duration": 123
        },
        "retry_config": {
          "duration": 123,
          "retry_count": 123,
          "type": "linear"
        },
        "source_metadata": {
          "body_function": "<string>",
          "created_at": "<string>",
          "custom_response": {
            "body": "<string>",
            "content_type": "<string>"
          },
          "deleted_at": "<string>",
          "forward_headers": [
            "<string>"
          ],
          "header_function": "<string>",
          "idempotency_keys": [
            "<string>"
          ],
          "is_disabled": true,
          "mask_id": "<string>",
          "name": "<string>",
          "project_id": "<string>",
          "provider": "github",
          "provider_config": {
            "twitter": {
              "crc_verified_at": "<string>"
            }
          },
          "pub_sub": {
            "amqp": {
              "auth": {
                "password": "<string>",
                "user": "<string>"
              },
              "bindedExchange": "<string>",
              "deadLetterExchange": "<string>",
              "host": "<string>",
              "port": "<string>",
              "queue": "<string>",
              "routingKey": "<string>",
              "schema": "<string>",
              "vhost": "<string>"
            },
            "google": {
              "project_id": "<string>",
              "service_account": [
                123
              ],
              "subscription_id": "<string>"
            },
            "kafka": {
              "auth": {
                "hash": "<string>",
                "password": "<string>",
                "tls": true,
                "type": "<string>",
                "username": "<string>"
              },
              "brokers": [
                "<string>"
              ],
              "consumer_group_id": "<string>",
              "topic_name": "<string>"
            },
            "sqs": {
              "access_key_id": "<string>",
              "default_region": "<string>",
              "queue_name": "<string>",
              "secret_key": "<string>"
            },
            "type": "sqs",
            "workers": 123
          },
          "type": "http",
          "uid": "<string>",
          "updated_at": "<string>",
          "url": "<string>",
          "verifier": {
            "api_key": {
              "header_name": "<string>",
              "header_value": "<string>"
            },
            "basic_auth": {
              "password": "<string>",
              "username": "<string>"
            },
            "hmac": {
              "encoding": "base64",
              "hash": "<string>",
              "header": "<string>",
              "secret": "<string>"
            },
            "type": "noop"
          }
        },
        "type": "cli",
        "uid": "<string>",
        "updated_at": "<string>"
      }
    ],
    "pagination": {
      "has_next_page": true,
      "has_prev_page": true,
      "next_page_cursor": "<string>",
      "per_page": 123,
      "prev_page_cursor": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
projectID
string
required

Project ID

Query Parameters

​
direction
enum<string>
Available options:
next,
prev
​
endpointId
string[]

A list of endpointIDs to filter by

​
name
string

Subscription name to filter by

​
next_page_cursor
string

A pagination cursor to fetch the next page of a list

​
perPage
integer

The number of items to return per page

​
prev_page_cursor
string

A pagination cursor to fetch the previous page of a list

​
sort
string

Sort order, values are ASC or DESC, defaults to DESC

Response

OK

​
message
string
​
status
boolean
​
data
object