SDKsAndroid

Search group members

Use searchGroupMembers to search group members by user ID or group nickname.

Search for group members in a specified group using keywords. You can search across member user IDs and in-group nicknames, making this useful for quick member lookups, administrative filtering, and mention selection.

Code example

String groupID = "group_123";
List<String> keywordList = Collections.singletonList("Tech");
boolean isSearchUserID = true;
boolean isSearchMemberNickname = true;
int offset = 0;
int count = 20;

OpenIMClient.getInstance().groupManager.searchGroupMembers(
    new OnBase<List<GroupMembersInfo>>() {
        @Override
        public void onSuccess(List<GroupMembersInfo> members) {
            // members contains matching group member profiles
        }

        @Override
        public void onError(int code, String error) {
            // Failed to search group members
        }
    },
    groupID,
    keywordList,
    isSearchUserID,
    isSearchMemberNickname,
    offset,
    count
);

Parameters

Parameter	Type	Required	Description
`base`	`OnBase<List<GroupMembersInfo>>`	Yes	Callback handler for the asynchronous request.
`groupID`	`String`	Yes	Globally unique ID of the target group.
`keywordList`	`List<String>`	Yes	List of search keywords. The search should not be executed if the list is empty.
`isSearchUserID`	`boolean`	Yes	Whether to search by user ID (`true` to match, `false` to ignore).
`isSearchMemberNickname`	`boolean`	Yes	Whether to search by in-group nickname (`true` to match, `false` to ignore).
`offset`	`int`	Yes	Starting offset for pagination, starting from `0`.
`count`	`int`	Yes	Maximum number of records to retrieve in this batch.

Return value

Upon success, onSuccess returns a list of matching member profiles (List<GroupMembersInfo>).

State changes after the call

Snapshot retrieval: This is a read-only search query that returns matching records at query time without altering group state.
Display results: Render search results using groupID:userID as the unique identifier for each item.

Was this page helpful?