SPspectate
Channels

List channels

Returns the team's channels, by name.

get/channels

Request

  • Base URL
    https://api.spectate.net/v1
  • Auth
    HTTP bearer

Query parameters

filter[type]'email' | 'slack' | 'discord' | 'microsoft_teams' | 'telegram' | 'webhook' | 'pushover' | 'sms' | 'voice'

Only channels of this type.

filter[enabled]boolean

Only enabled (true) or disabled (false) channels.

pageinteger

Page number, from 1.

per_pageinteger

Channels per page, 1 to 100.

Response

Paginated set of Channel

current_pageinteger required
first_page_urlstring nullable required
frominteger nullable required
last_page_urlstring nullable required
last_pageinteger required
next_page_urlstring nullable required
pathstring nullable required

Base path for paginator generated URLs.

per_pageinteger required

Number of items shown per page.

prev_page_urlstring nullable required
tointeger nullable required

Number of the last item in the slice.

totalinteger required

Total number of items being paginated.

Example response

{
  "data": [
    {
      "name": "On-call email",
      "email": {
        "address": "oncall@example.com"
      },
      "slack": {
        "channel": "C0123456789",
        "channel_name": "#alerts"
      },
      "telegram": {
        "chat_id": "-1001234567890",
        "chat_title": "Ops alerts"
      },
      "webhook": {
        "host": "hooks.example.com"
      },
      "pushover": {
        "user_key": "uQiRzpo4DXghDmr9QzzfQu27cmVRsG",
        "priority": 1
      },
      "sms": {
        "phone_number": "+31612345678"
      },
      "voice": {
        "phone_number": "+31612345678"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.