b2_list_groups

GET {{apiUrl}}/b2api/v2/b2_list_groups?adminAccountId={{accountId}}

Lists active Groups for an authorized Group admin.

A single Group admin can administer a maximum of 500 groups.

Request Params

When groupName is specified, the result will be a list of active Groups matching this Group name for which the accountId is an ACCEPTED Group admin, or no Groups if the account does not have any Groups with this name or the Group admin accountId is not an ACCEPTED Group admin for the Group. If multiple Groups have the same name, all Groups with that name will be returned. | | startGroupId | null | | Optional. If the starting groupId is provided, the search will begin with this startGroupId. If startGroupId is not provided, then the search will begin with the first Group. | | maxGroupCount | null | | Optional. If provided, the number of Groups to return expressed as an integer between 1 and 100. Defaults to 100. If more Groups exist, the response's nextGroupId will be populated with a startGroupId suitable for use in a subsequent query. Providing a startGroupId and a maxGroupCount of 1 will return just the Group with the startGroupId. |

HEADERS

RESPONSES

status: OK

{"accountId":"0123456789ab","groups":[{"accountStandingDetails":{"state":"B2_GOOD_STANDING"},"b2Stats":{"b2BytesStoredCount":0,"b2FilesStoredCount":0,"b2StatsAsOfTimestamp":"d20240511_m221251","bucketCount":0},"groupId":"123456","groupName":"B2 Group","groupProducts":["STORAGE"],"groupStats":{"createdTimestamp":"d20220202_m201921","groupStatsAsOfTimestamp":"d20240512_m010709","memberCount":1}}],"nextGroupId":null}