> ## Documentation Index
> Fetch the complete documentation index at: https://social-b97141fb-feat-user-history-moderation-detail.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Member Management Overview

> Choose the SDK surfaces for joining, leaving, querying, searching, and previewing chat channel members.

Member management is the SDK surface for deciding who is in a channel and how your app reads that membership state. Use these pages when you need join and leave flows, member lists, mention pickers, moderator lists, or membership-aware UI.

## Capability Map

| Capability | Use it for | SDK page |
| - | - | - |
| Join a channel | Add the current user to a joinable channel. | [Join & Leave Channel](./join-leave-channel) |
| Leave a channel | Remove the current user from a channel where leaving is allowed. | [Join & Leave Channel](./join-leave-channel) |
| Read current membership | Hide composer controls, redirect banned users, or show join prompts. | [Join & Leave Channel](./join-leave-channel) |
| Query members | Build member lists, moderator lists, banned lists, or muted lists. | [Query Members](./query-members) |
| Search members | Build mention pickers and member directories. | [Query Members](./query-members) |
| Preview members | Show a small channel-member sample where the platform exposes preview members. | [Preview Members](./preview-members) |

## Platform Surface

| Surface | TypeScript | iOS | Android | Flutter |
| - | - | - | - | - |
| Join channel | Supported | Supported | Supported | Supported |
| Leave channel | Supported | Supported | Supported | Supported |
| Current membership state | Supported | Supported | Supported | Supported |
| Query members | Supported | Supported | Supported | Supported |
| Search members | Supported | Supported | Supported | Supported |
| Role filters | Supported | Supported | Supported | Supported |
| Preview-member field | Supported | Supported | Use member-query fallback | Use member-query fallback |

## Parameters

| Parameter | Required | Description |
| - | - | - |
| `channelId` | Yes | Channel whose membership state should be read or changed. |
| Membership filter | No | Filter member queries by state such as member, banned, muted, or all where supported. |
| `roles` | No | Filter members by channel role, such as `moderator` or another role configured for your app. |
| Search keyword | No | Search member display names where the platform exposes member search. |
| `includeDeleted` | No | Include deleted users in member query results where supported. |

## Implementation Shape

<CardGroup cols={2}>
  <Card title="Gate channel UI" href="./join-leave-channel" icon="door-open">
    Read membership before showing the composer, join button, leave action, or banned-state messaging.
  </Card>

  <Card title="Build member lists" href="./query-members" icon="users">
    Query members by channel, membership state, role, search keyword, and deletion state where supported.
  </Card>

  <Card title="Support mentions" href="./query-members" icon="at">
    Use member search for mention pickers and user-selection flows.
  </Card>

  <Card title="Show previews" href="./preview-members" icon="eye">
    Use preview members where exposed; otherwise query a small member page for fallback display.
  </Card>
</CardGroup>

## Related Topics

<CardGroup cols={3}>
  <Card title="Role Management" href="../channels/governance/role-management" icon="user-gear">
    Assign or remove channel roles for members.
  </Card>

  <Card title="Ban Management" href="../channels/governance/ban-management" icon="user-slash">
    Remove channel access until a user is unbanned.
  </Card>

  <Card title="Mute Management" href="../channels/governance/mute-management" icon="microphone-slash">
    Restrict sending while keeping channel access.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.