Skip to main content
GET
/
channels
List Channels
curl --request GET \
  --url https://api.example.com/channels

Request

curl https://api.certwatch.app/v1/channels \
  -H "Authorization: Bearer YOUR_API_KEY"

Query Parameters

ParameterTypeDescription
typestringFilter by type: email, slack, discord, webhook
enabledbooleanFilter by enabled status

Response

{
  "data": [
    {
      "id": "ch_email123",
      "type": "email",
      "name": "Team Email",
      "enabled": true,
      "config": {
        "email": "[email protected]"
      },
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-08T12:00:00Z"
    },
    {
      "id": "ch_slack456",
      "type": "slack",
      "name": "Engineering Slack",
      "enabled": true,
      "config": {
        "channel": "#engineering-alerts",
        "workspaceName": "Acme Inc"
      },
      "createdAt": "2024-01-02T00:00:00Z",
      "updatedAt": "2024-01-08T12:00:00Z"
    },
    {
      "id": "ch_discord789",
      "type": "discord",
      "name": "Discord Alerts",
      "enabled": true,
      "config": {
        "webhookConfigured": true
      },
      "createdAt": "2024-01-03T00:00:00Z",
      "updatedAt": "2024-01-08T12:00:00Z"
    },
    {
      "id": "ch_webhook000",
      "type": "webhook",
      "name": "PagerDuty",
      "enabled": false,
      "config": {
        "url": "https://events.pagerduty.com/..."
      },
      "createdAt": "2024-01-04T00:00:00Z",
      "updatedAt": "2024-01-08T12:00:00Z"
    }
  ],
  "meta": {
    "total": 4,
    "requestId": "req_xyz789"
  }
}

Response Fields

FieldTypeDescription
idstringUnique channel identifier
typestringChannel type
namestringDisplay name
enabledbooleanWhether channel receives notifications
configobjectChannel-specific configuration
createdAtstringWhen channel was created
updatedAtstringLast update time

Config by Type

Email

{
  "email": "[email protected]"
}

Slack

{
  "channel": "#channel-name",
  "workspaceName": "Workspace Name"
}

Discord

{
  "webhookConfigured": true
}

Webhook

{
  "url": "https://your-endpoint.com/webhook"
}

Errors

401 Unauthorized

{
  "error": {
    "code": "invalid_api_key",
    "message": "The provided API key is invalid"
  }
}