Infomaniak Kchat icon

Infomaniak Kchat

Interact with Infomaniak Kchat API

Actions173

Channels → Get A List Of All Channels

AI-generated

Summary

Retrieves all channels for an Infomaniak Kchat team, with optional filtering, pagination, and response formatting controls.

Inputs

  • authentication (required) — Authentication method to use for the Infomaniak Kchat API request.
  • teamName (required) — Your kChat team name (the subdomain in https://.kchat.infomaniak.com).
  • queryParameters — Optional query parameters to filter and paginate the channel list.
  • returnAll — If true, returns all items across paginated results. Defaults to true.
  • returnFullResponse — If true, returns the full API response object instead of just the channels array. Defaults to false.

Output shape

An object containing a channels array with channel metadata. If query_include_total_count is set to true, the response includes a total_count field. If returnFullResponse is true, the entire raw API response is returned.

Pagination is handled via query_page and query_per_page. The returnAll parameter controls whether all pages are fetched automatically.

Examples

Example 1: List all non-default channels for a team using OAuth2 authentication.

authentication: oauth2; teamName: my-team; queryParameters: { query_exclude_default_channels: true }

Links

Discussion