Interface ListGroupMembersRequest`Experimental`

Request parameters for b2_list_group_members.

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

interface ListGroupMembersRequest {
    adminAccountId: AccountId;
    groupId: GroupId;
    maxMemberCount?: number;
    startEmail?: string;
}

Properties

adminAccountId: AccountId

Account ID of the group administrator authorized for the Partner API.

groupId: GroupId

Group ID whose active members should be listed.

maxMemberCount?: number

Maximum number of group members to return. The documented maximum is 1000.

startEmail?: string

First member email address to return for pagination.