This action retrieves a list of open channels. You can use various query parameters to determine the search scope and select what kind of information you want to receive about the queried channels.
The following table lists the parameters that this action supports.
Specifies a page token that indicates the starting index of a chunk of results to retrieve. If not specified, the index is set as 0.
Specifies the number of results to return per page. Acceptable values are
Specifies a comma-separated string of one or more custom types to filter open channels. Urlencoding each type is recommended (for example,
Searches for open channels containing the specified value in their channel names. Note that this parameter is
Searches for open channels containing the specified value in their channel URLs. Urlencoding the value is recommended.
Determines whether to include frozen channels in the response. Frozen channels are channels where only channel operators are allowed to send messages. (Default:
Determines whether to include channel metadata in the response. (Default:
(Deprecated) Searches channels whose
If successful, this action returns a list of open channel resources that match the query parameters in the response body.
array of objects
An array of open channel resources that match the specified optional parameters.
The value for the
In the case of an error, an error object like below is returned. See the error codes section for more details.