product:chat

Query channels

Changed on Oct 30, 2026

Query channels with filter query

post/channels

Request

Base URL
https://chat.stream-io-api.com
URL
https://chat.stream-io-api.com/channels
Auth
- API key in header Authorization and API key in query parameter api_key and API key in header Stream-Auth-Type
- or API key in query parameter api_key and API key in header Stream-Auth-Type

Request body

filter_conditionsobject

Filter conditions to apply to the query

filter_valuesobject

Values to interpolate into the predefined filter template

include_active_member_countboolean

Whether to include active_member_count for each channel

limitinteger

Number of channels to limit

member_custom_includestring[]

Top-level keys of the message sender's channel-member custom data to include under member.custom (max 8 keys, 64 chars each)

member_limitinteger

Number of members to limit

message_limitinteger

Number of messages to limit

offsetinteger

Channel pagination offset

predefined_filterstring

ID of a predefined filter to use instead of filter_conditions

sort_valuesobject

stateboolean

Whether to update channel state or not

user_idstring

Response

Channels list

durationstring required

Duration of the request in milliseconds

Changes

Oct 30, 202600df5052235b Revision changes
- info
  added the optional property ////// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property ///////// to the response with the status
- info
  added the optional property ///////// to the response with the status
- info
  added the optional property ///////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
Oct 29, 20268acf79c23a74 Revision changes
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the optional property ///////// to the response with the status
- info
  added the optional property ///////// to the response with the status
- info
  added the optional property ///////// to the response with the status
- info
  added the optional property ///////// to the response with the status
- info
  added the optional property ///////// to the response with the status
- info
  added the optional property ///////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status

Operation history (69 revisions)

Query channels

Request

Request body

Response 201Created

Changes

Response