Interface ListGroupsRequest`Experimental`

Request parameters for b2_list_groups.

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

interface ListGroupsRequest {
    adminAccountId: AccountId;
    groupName?: string;
    maxGroupCount?: number;
    startGroupId?: GroupId;
}

Properties

adminAccountId: AccountId

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

groupName?: string

Optional group name filter. Multiple groups may share the same name.

maxGroupCount?: number

Maximum number of groups to return. The documented range is 1 through 100.

startGroupId?: GroupId

Group ID to start listing from for pagination.