Interface ListGroupMembersResult`Experimental`

One page of members for a group, returned by b2_list_group_members.

Partner API surface; shape may change as the Partner API docs evolve.

interface ListGroupMembersResult {
    groupId: GroupId;
    groupMembers: readonly ListedGroupMember[];
    groupName: string;
    nextEmail: string | null;
}

Index

Properties

groupId groupMembers groupName nextEmail

Properties

`Readonly` `Experimental`groupId

groupId: GroupId

Group ID whose members were listed.

`Readonly` `Experimental`groupMembers

groupMembers: readonly ListedGroupMember[]

Active accepted group members matching the request.

`Readonly` `Experimental`groupName

groupName: string

Human-readable group name.

`Readonly` `Experimental`nextEmail

nextEmail: string | null

Next email address to use for pagination, or null if all members have been listed.