Infomaniak Kchat icon

Infomaniak Kchat

Interact with Infomaniak Kchat API

Actions173

Users → Search Users

AI-generated

Summary

Search kChat users matching a term across username, full name, nickname, and email.

Inputs

  • authentication — Authentication method to use for Infomaniak API access.
  • teamName (required) — Your kChat team name (the subdomain in https://.kchat.infomaniak.com)
  • body_term (required) — The term to match against username, full name, nickname and email
  • bodyParameters — Optional filters for team, channel, group, and result constraints.
  • returnFullResponse — If true, returns the complete API response instead of extracted user data.

Output shape

Array of user objects matching the search criteria. When returnFullResponse is false (default), only essential user data is returned; otherwise the full API payload is returned.

Results are filtered per the selected bodyParameters. body_without_team takes precedence over team_id, in_channel_id, and not_in_channel_id.

Examples

Example 1: Search for users by name within a specific team

authentication: OAuth2, teamName: my-team, body_term: john, body_parameters: { body_team_id: my-team-id }

Links

Discussion