Skip to main content
POST
/
channel
/
list
List channels
curl --request POST \
  --url 'https://api.flashcat.cloud/channel/list?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "p": 1,
  "limit": 20,
  "orderby": "created_at",
  "asc": false
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "total": 42,
    "has_next_page": true,
    "items": [
      {
        "channel_id": 1001,
        "channel_name": "Production Alerts",
        "status": "enabled"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.flashcat.cloud/llms.txt

Use this file to discover all available pages before exploring further.

​
Restrictions

AspectValue
Rate limits1,000 requests/minute; 50 requests/second per account
PermissionsNone — any valid app_key can call this operation

Authorizations

​
app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json
​
p
integer

Page number (1-based).

Required range: x >= 1
​
limit
integer
default:100

Page size. Defaults to 100 when omitted.

Required range: 1 <= x <= 100
​
orderby
enum<string>

Field used to order results.

Available options:
ranking,
created_at,
updated_at,
channel_name,
last_incident_at
​
asc
boolean

When true, sort ascending.

​
is_my_managed
boolean

When true, return only channels the caller manages.

​
is_my_starred
boolean

When true, return only channels the caller has starred. Mutually exclusive with is_my_team.

​
is_brief
boolean

When true, return only brief fields (channel_id, channel_name, description, status).

​
is_my_team
boolean

When true, return channels owned by the caller's teams. Mutually exclusive with is_my_starred.

​
team_ids
integer<int64>[]

Filter by team IDs.

​
query
string

Free-text query against channel name/description.

​
channel_ids
integer<int64>[]

Filter by explicit channel IDs.

​
channel_name
string

Exact-match filter on channel name. Takes priority over query for name filtering.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

​
request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

​
data
object
required

Endpoint-specific payload. See each operation's 200 response schema.