listChannels method
List group channels across connected chat providers.
Fan-out list. The Channels surface filters to channel-type conversations only (type: channel | private); for direct messages use /v1/direct-messages.
Parameters:
-
List<String> accountIds: Repeatable. Restrict to these connected-account row ids. Mutually orthogonal to
providers— when both are set the intersection is used. -
List<String> providers: Repeatable. Restrict to these provider ids (
gmail,outlook). -
String xWorkspaceID: Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
-
int limit:
-
String cursor: Provider-specific pagination cursor.
-
bool includeArchived:
-
List<String> types: Repeatable filter on
Channel.type. Defaults applied by the platform exclude DMs; passing this overrides.
Implementation
Future<ListChannelsResponse?> listChannels({ List<String>? accountIds, List<String>? providers, String? xWorkspaceID, int? limit, String? cursor, bool? includeArchived, List<String>? types, }) async {
final response = await listChannelsWithHttpInfo( accountIds: accountIds, providers: providers, xWorkspaceID: xWorkspaceID, limit: limit, cursor: cursor, includeArchived: includeArchived, types: types, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'ListChannelsResponse',) as ListChannelsResponse;
}
return null;
}