Help Center/ KooDrive/ API Reference/ API/ Space Management/ Listing Group Spaces in an Enterprise

Updated on 2024-07-30 GMT+08:00

View PDF

Listing Group Spaces in an Enterprise

Function

List group spaces in an enterprise. (Only tenant administrators have the permission to call this API.)

URI

GET /koodrive/ose/v1/space/groupList

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
offset	Yes	Integer	Offset. Minimum value: 0.
limit	Yes	Integer	Maximum number of records to be returned. Value range: 1 to 100.
keyWord	No	String	Search keyword. You can use name and ownerNamer as the search criteria.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Authorization	Yes	String	Access token. Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}.
X-Traceid	No	String	Message log trace ID. The value contains 58 bits.
language	No	String	Language code, which complies with the internationalization specifications. For example, en-US indicates English (United States). English (United States) is used by default.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
code	String	Error code.
msg	String	Error message.
total	Integer	Total number of records.
groupsTotal	Integer	Total number of groups.
groupsMax	Integer	Maximum number of groups.
assignedCapacity	String	Assigned capacity.
maxCapacity	String	Maximum capacity.
groups	Array of TeamSpaceInfo objects	Group space information.

**Table 4** TeamSpaceInfo
Parameter	Type	Description
id	String	ID of the department, user group, or group to which the space belongs.
groupName	String	Team space name, which is a department or user group name.
status	Integer	Space status.
capacity	Integer	Space size.
spaceUsed	String	Size of the used space.
containerId	String	Space ID.
userNum	Integer	Number of users.
ownerId	String	Owner ID.
ownerName	String	Owner name.
tenantId	String	Tenant ID.
creator	String	Creator.
createTime	String	Creation time.
modifier	String	ID of the user who updated the information.
updateTime	String	Update time.
bizRootFileId	String	ID of the space root directory.
bizSboxFileId	String	ID of the space safe directory.
iconUrl	String	Icon link.
top	Integer	Whether this record is pinned to top.
role	Integer	Role.
deptNamePath	String	Department location.

Example Requests

Lists group spaces in an enterprise.

GET  /koodrive/ose/v1/space/groupList?offset=0&limit=10 

Authorization:Bearer+10f88**********4791e9ff

Example Responses

Status code: 200

Information about the group space list.

{
    "total": 1,
    "groupsTotal": 1,
    "groupsMax": 500,
    "assignedCapacity": 100,
    "maxCapacity": 2048,
    "groups": [
        {
            "tenantId": "cad444830661464d9da88784a96d960c",
            "creator": "1410172329509745795",
            "createTime": "2024-05-10T01:46:22.000Z",
            "modifier": "1410172329509745795",
            "updateTime": "2024-05-10T02:27:23.000Z",
            "ownerId": "1410172329509745795",
            "status": 0,
            "capacity": 20,
            "spaceUsed": 0,
            "containerId": "IAAE49hOR8LulgAAA1417956457328121729",
            "bizRootFileId": "DE5Hwu6WAAAArootIAAE49hOR8LulgAAA1417956457328121729",
            "bizSboxFileId": "DE5Hwu6WAAAAsboxIAAE49hOR8LulgAAA1417956457328121729",
            "id": "1417956457311344513",
            "groupName": "api01",
            "iconUrl": "1",
            "ownerName": "hid99522477",
            "userNum": 1
        },
  "code" : 0, 
  "msg": "Successful"
}