Copied.
Viewing the Shared Folders I Created or Joined
Function
View the shared folders I created or joined.
URI
GET /koodrive/ose/v1/sharefolder/list
Parameter | Mandatory | Type | Description |
|---|---|---|---|
offset | Yes | Integer | Definition: Pagination offset. Constraints: N/A Range: N/A Default Value: N/A |
limit | Yes | Integer | Definition: Number of records on each page. Constraints: N/A Range: 1~1000 Default Value: N/A |
keyWord | No | String | Definition: Keyword for searching shared folders. This parameter is mandatory if a shared folder is searched. Constraints: The length is less than or equal to 32. Range: N/A Default Value: N/A |
status | No | String | Definition: Shared folder status. Constraints: Currently, only shared folders in the normal status can be queried. Range: 0- normal 1- deleted Default Value: 0 |
queryType | No | Integer | Definition: Shared folder type. Constraints: N/A Range: 0- View all families 1- View the shared folders I created 2- View the shared folders I joined Default Value: N/A |
Request Parameters
Parameter | Mandatory | Type | Description |
|---|---|---|---|
Authorization | Yes | String | Definition: 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}. Constraints: N/A Range: N/A Default Value: N/A |
X-Traceid | No | String | Definition: Service trace ID, which contains 58 bits. Constraints: N/A Range: The value contains 58 bits. Default Value: N/A |
language | No | String | Definition: Language code. Constraints: The value must comply with the internationalization specifications. For example, en_us indicates English (United States). Range: The value must comply with the internationalization specifications. Default Value: en-US |
X-User-Id | Yes | String | Definition: User ID on KooDrive, which is used for app authentication. Constraints: N/A Range: N/A Default Value: N/A |
X-Date | Yes | String | Definition: Date, which is used for app authentication. Constraints: The format is yyyyMMDD'T'HHmmss'Z', for example, 20251103T070140Z. Range: The value must be within 15 minutes from the current time and cannot be later than the current time. Default Value: N/A |
Response Parameters
Status code: 200
Parameter | Type | Description |
|---|---|---|
folders | Array of ShareFolder objects | Shared folder information. |
code | Integer | Response code. |
msg | String | Response. |
Parameter | Type | Description |
|---|---|---|
tenantId | String | Tenant ID. |
creator | String | Creator ID. |
createTime | String | Creation time. |
ownerId | Long | Owner ID of the shared folder. |
status | Integer | Shared folder status. 0: normal 1: deleted |
id | String | Primary key ID of a shared folder. |
containerId | String | ID of the space to which a shared folder belongs. |
shareFolderFileId | String | Shared folder file ID. |
name | String | Shared folder name. |
groupId | String | User group ID. |
maxMember | Integer | Family size limit. |
Example Requests
View all shared folders of the current user.
GET /koodrive/ose/v1/sharefolder/list?keyWord=Family&limit=100&queryType=0
Example Responses
Status code: 200
Return all shared folders in a container.
{
"folders" : [ {
"tenantId" : "c937ff95eeb44494a5a967e21d1852ae",
"createTime" : "2025-08-29T09:43:34.461Z",
"ownerId" : 1644817543959100000,
"status" : 0,
"id" : "1763189892776573825",
"shareFolderFileId" : "FlSntuhqXpj3GVwtBqjlBM4P-2bDzldE9",
"name" : "Test Folder 12435564",
"groupId" : "1763189892617190272",
"containerId" : "IAAFanxbXNArpAncA1645841408025905537",
"maxMember" : 2
}, {
"tenantId" : "c937ff95eeb44494a5a967e21d1852ae",
"createTime" : "2025-08-29T09:33:18.793Z",
"ownerId" : 1644817543959100000,
"status" : 0,
"id" : "1763184728179035905",
"shareFolderFileId" : "Fmo-XZ-S0SKR993tX73tPPIxYo20Ntj-k",
"name" : "Sharing Test 1",
"groupId" : "1763184728103538432",
"containerId" : "IAAFanxbXNArpAncA1645841408025905537",
"maxMember" : 2
}, {
"tenantId" : "c937ff95eeb44494a5a967e21d1852ae",
"createTime" : "2025-08-26T08:58:46.616Z",
"ownerId" : 1644817543959100000,
"status" : 0,
"id" : "1760993018304891649",
"shareFolderFileId" : "FlDnVW2MKgyQb6Yay98ZObYLu4VGKCPQk",
"name" : "122",
"groupId" : "1760993018187451136",
"containerId" : "IAAFanxbXNArpAncA1645841408025905537",
"maxMember" : 2
} ],
"code" : 0,
"msg" : "Success."
} Status Codes
Status Code | Description |
|---|---|
200 | Return all shared folders in a container. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
