Infomaniak Kchat icon

Infomaniak Kchat

Interact with Infomaniak Kchat API

Actions173

Channels → Search All Private And Open Type Channels

AI-generated

Summary

Search kChat channels matching a term in name, display name, or purpose, with optional filters for privacy, group constraints, deletion status, and pagination.

Inputs

  • teamName (required) — Your kChat team name (the subdomain in https://.kchat.infomaniak.com)
  • body_term (required) — The string to search in the channel name, display name, and purpose
  • authentication — Authentication method; defaults to OAuth2, supports API Key as alternative
  • body_public — Filters results to only return Public / Open channels
  • body_private — Filters results to only return Private channels
  • body_deleted — Filters results to only return deleted / archived channels
  • body_page — The page number to return, if paginated
  • body_per_page — The number of entries to return per page, if paginated
  • body_exclude_default_channels — Exclude default channels from the results
  • body_group_constrained — Filters results to only return channels constrained to a group
  • body_exclude_group_constrained — Excludes channels constrained to a group
  • body_exclude_policy_constrained — If true, only return channels without a granular retention policy assigned
  • body_include_search_by_id — If true, search term matches channel ID
  • body_not_associated_to_group — A group id to exclude channels associated to that group
  • queryParameters — Additional query parameters; includes query_system_console to filter by logged-in user
  • returnFullResponse — Return the full API response instead of parsed items

Output shape

Array of channel objects matching the search criteria, or full API response if returnFullResponse is enabled

Authenticated via OAuth2 or API Key. The infomaniakApiRequest function (from GenericFunctions.js) handles the API call, with pagination supported via page and per_page parameters.

Links

Discussion