Infomaniak Kchat icon

Infomaniak Kchat

Interact with Infomaniak Kchat API

Actions173

Channels → Get Deleted Channels

AI-generated

Summary

Retrieve deleted channels for a kChat team.

Inputs

  • authentication — Authentication method to use for the Infomaniak API call. Defaults to OAuth2 if not specified. Select OAuth2 or API Key depending on your Infomaniak kChat setup credentials type; default is OAuth2; API Key uses the team name and path_team_id as credentials.
  • teamName (required) — Your kChat team name (the subdomain in https://.kchat.infomaniak.com)
  • path_team_id (required) — Team GUID
  • queryParameters — Optional pagination parameters. query_page selects the page number (default 0). query_per_page sets the number of public channels per page (default 0, respects node limit).
  • returnAll — When enabled, fetches all available pages of deleted channels. Default is true; if disabled, only the first page matching the limit is returned.
  • returnFullResponse — When true, returns the complete API response object instead of just the items array. Default is false.

Output shape

An array of deleted channel objects retrieved from the Infomaniak kChat API. The returned data includes channel metadata such as ID, name, creation timestamp, and deletion status. When returnAll is true, the result contains all pages aggregated. If returnFullResponse is true, the full API response envelope is returned alongside the items.

The operation specifically targets deleted channels; active or archived channels are not included in the result set.

Examples

Example 1: List all deleted channels for a team using OAuth2 authentication.

authentication: OAuth2; teamName: my-team; path_team_id: ; returnAll: true; returnFullResponse: false

Links

Discussion