Infomaniak Kchat icon

Infomaniak Kchat

Interact with Infomaniak Kchat API

Actions173

Channels → Get Private Channels

AI-generated

Summary

Retrieve private channels for a kChat team, with optional pagination and full response.

Inputs

  • authentication — Authentication method to use for the Infomaniak KChat API request. Defaults to OAuth2 if not specified. Select API Key if using a personal access token.
  • teamName (required) — Your kChat team name (the subdomain in https://.kchat.infomaniak.com). This is the human‑readable team identifier.
  • path_team_id (required) — The GUID of the kChat team. Required when operating on a specific team identifier rather than the subdomain.
  • queryParameters — Optional query parameters to paginate or limit results. Includes page (query_page) and per‑page limit (query_per_page).
  • returnAll — When enabled (default true), the operation will paginate through all available pages and return a consolidated array of private channels. When disabled, only the first page of results is returned.
  • returnFullResponse — When enabled, the raw API response is returned without parsing into n8n items. When disabled (default), results are structured into n8n items for downstream use.

Output shape

Array of private channel objects, each containing the channel's metadata (e.g., ID, name, members, timestamps). If returnFullResponse is true, the output is the raw API response object instead of parsed items.

The operation respects the returnAll flag by internally using the infomaniakApiRequestAllPages helper to fetch every page. Pagination parameters (query_page, query_per_page) are optional; defaults are applied when omitted.

Examples

Example 1: Get first 20 private channels for team 'my-team' using OAuth2.

authentication: OAuth2; teamName: my-team; path_team_id: ; queryParameters: { query_per_page: 20 }; returnAll: false

Links

Discussion