Skip to main content
POST
List channels

Restrictions

Usage

  • Without filters, every channel in the account is returned except private channels the caller cannot access. Deleted channels are never returned.
  • Setting both is_my_team and is_my_starred to true returns InvalidParameter. is_my_managed takes precedence over both. With is_my_managed or is_my_team, team_ids is ignored.
  • With is_brief: true, items carry only channel_id, channel_name, description, status and is_starred, and all matches are returned in one page.
  • Always pass p. When it is omitted the first page is returned, but has_next_page is then true whenever anything matches.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json
p
integer

Page number, starting at 1. Always pass it: when omitted the first page is returned but has_next_page is unreliable.

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

Page size. Defaults to 100 when omitted.

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

Sort field, default created_at. ranking uses the caller's own channel order saved in the console and falls back to creation order when none is saved; channel_name sorts case-insensitively.

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

When true, sort ascending; defaults to false (descending).

is_my_managed
boolean

When true, return only channels owned by one of the caller's teams or created by the caller. Takes precedence over is_my_team and is_my_starred.

is_my_starred
boolean

When true, return only channels the caller has starred. Cannot be combined with is_my_team.

is_brief
boolean

When true, return only channel_id, channel_name, description, status and is_starred for each channel, with all matches in one page.

is_my_team
boolean

When true, return only channels whose owning team is one of the caller's teams. Cannot be combined with is_my_starred.

team_ids
integer<int64>[]

Return only channels owned by these teams. Ignored when is_my_managed or is_my_team is true.

query
string

Case-insensitive regular expression matched against channel name and description; invalid regex syntax falls back to a literal match. Must be valid UTF-8 — invalid byte sequences are rejected with InvalidParameter.

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. Must be valid UTF-8 — invalid byte sequences are rejected with InvalidParameter.

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

Operation-specific payload, documented in each operation's 200 response. Operations without a payload return {} or omit data entirely.