/channels (GET)

GET

/channels

const url = 'https://culipulse.dev/v1/channels';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://culipulse.dev/v1/channels \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth
read

Responses

200

List channels

application/json

object

channels

required

Array<object>

object

required

string

type

required

string

Allowed values: telegram slack webhook

name

required

string

enabled

required

boolean

created_at

required

integer

status

required

string

Allowed values: connected pending

all_monitors

required

True = alerts for every monitor; false = only monitor_ids.

boolean

monitor_ids

required

Monitors routed to this channel when all_monitors is false. Sorted.

Array<string>

url_host

Webhook only. The full URL is never returned.

string | null

team_name

Slack only.

string | null

channel_name

Slack only.

string | null

Example

{
  "channels": [
    {
      "id": "ch_123",
      "type": "telegram",
      "status": "connected"
    }
  ]
}

401

Unauthorized

application/json

object

error

required

string

request_id

string

code

Present on some 400s so a client can branch without parsing error. Known values: channel_limit_reached, too_many_monitors, duplicate_webhook_url.

string

field

The request field the error is about, when there is one.

string

limit

The limit that was hit, when code names one.

integer

Example

{
  "error": "not found",
  "request_id": "req_abc123",
  "code": "channel_limit_reached"
}