SDKsAndroid

Get group members

Use getGroupMemberList to retrieve group members by role and page.

Retrieve a paginated list of members for a specified group. You can filter members by role (all members, regular members, group owner, or group administrators), making this suitable for member rosters, permission management, and @ mention pickers.

Code example

String groupID = "group_123";
int filter = 0; // 0: retrieve all members
int offset = 0;
int count = 50;

OpenIMClient.getInstance().groupManager.getGroupMemberList(
    new OnBase<List<GroupMembersInfo>>() {
        @Override
        public void onSuccess(List<GroupMembersInfo> members) {
            // members contains the list of group members for the current page
        }

        @Override
        public void onError(int code, String error) {
            // Failed to retrieve group members
        }
    },
    groupID,
    filter,
    offset,
    count
);

Role filter values

The filter parameter filters group members based on their assigned role:

Value	Description
`0`	All group members.
`1`	Regular group members only.
`2`	Group owner only.
`3`	Group administrators only.

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.
`filter`	`int`	Yes	Role filter flag (`0`: all, `1`: regular members, `2`: owner, `3`: administrators).
`offset`	`int`	Yes	Starting offset for pagination, starting from `0`.
`count`	`int`	Yes	Maximum number of member records to retrieve in this batch.

Return value

Upon success, onSuccess returns a list of group member objects (List<GroupMembersInfo>). Key fields of each member include:

Field	Description
`groupID`	Group ID.
`userID`	User ID of the member.
`nickname`	Display name of the member within the group.
`faceURL`	Profile avatar URL of the member.
`roleLevel`	Role level: `20` for regular members, `60` for administrators, and `100` for the group owner.
`joinTime`	Timestamp in milliseconds when the member joined the group.
`muteEndTime`	Timestamp in milliseconds when the mute expires (`0` indicates not muted).

State changes after the call

Snapshot retrieval: This is a read-only query that fetches a point-in-time member list snapshot and does not mutate group state or trigger membership events.
Cache maintenance: Clients should cache and deduplicate members using groupID:userID as the composite key.
Incremental sync: Subsequent membership changes are dispatched asynchronously via events such as onGroupMemberAdded, onGroupMemberDeleted, and onGroupMemberInfoChanged. For complete event handling, see Group overview.

Was this page helpful?