Infomaniak Kchat icon

Infomaniak Kchat

Interact with Infomaniak Kchat API

Actions173

Groups → Get Channel Groups

AI-generated

Summary

Retrieves channel groups for a specified kChat team, supporting pagination, filtering, and response format control.

Inputs

  • authentication — Authentication method to use for API requests. Defaults to OAuth2 if not configured otherwise.
  • teamName (required) — Your kChat team name (the subdomain in https://team-name.kchat.infomaniak.com)
  • path_channel_id (required) — Channel GUID to filter groups by specific channel
  • queryParameters — Optional query parameters for request tuning.
  • queryParameters.options.query_page — The page to select.
  • queryParameters.options.query_per_page — The number of groups per page.
  • queryParameters.options.query_filter_allow_reference — Boolean which filters the group entries with the allow_reference attribute set.
  • returnAll — When true, returns all pages of results by following pagination links. When false, the limit parameter is applied.
  • limit — Maximum number of items to return. Applied when returnAll is false. Min 1, max 500. Default 50.
  • returnFullResponse — When true, returns the full API response body instead of just the items array.

Output shape

Array of channel group objects retrieved from the Infomaniak kChat API. Pagination merges all pages when returnAll is true; otherwise the result set is capped at the specified limit. If returnFullResponse is true, the entire API response is returned instead.

The operation uses the infomaniakApiRequestAllPages helper for paginated fetching when returnAll is enabled. Channel groups are filtered by the provided teamName and optional path_channel_id.

Examples

Example 1: Fetch all channel groups for a team using OAuth2.

authentication: OAuth2; teamName: my-team; returnAll: true

Links

Discussion