Help Center/KooDrive/API Reference（Carrier）/API/Shared Folder Management/Viewing Details About a Shared Folder
Updated on 2026-02-12 GMT+08:00
View PDF
Share

Viewing Details About a Shared Folder

Function

View details about a shared folder.

URI

GET /koodrive/ose/v1/sharefolder/metadata/{shareFolderId}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

shareFolderId

Yes

String

Definition:

Primary key ID of a shared folder.

Constraints:

The length cannot exceed 100.

Range:

N/A

Default Value:

N/A

Request Parameters

Table 2 Request header 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

Table 3 Response body parameters

Parameter

Type

Description

sharefolder

ShareFolder object

Shared folder information.

code

Integer

Response code.

msg

String

Response.

Table 4 ShareFolder

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 details about a shared folder.

GET /koodrive/ose/v1/sharefolder/metadata/1760193846718860033

Example Responses

Status code: 200

Return to shared folder details.

{
  "shareFolder" : {
    "tenantId" : "c937ff95eeb44494a5a967e21d1852ae",
    "creator" : "1644817543959100032",
    "createTime" : "2025-08-25T06:30:57.939Z",
    "ownerId" : 1644817543959100000,
    "status" : 0,
    "id" : "1760193846718860033",
    "shareFolderFileId" : "FvhpCQvBoWaHvMeCqPppBuqjNdkgZai6h",
    "name" : "Family A",
    "groupId" : 1760193846660139800,
    "containerId" : "IAAFanxbXNArpAncA1645841408025905537",
    "maxMember" : 2
  },
  "code" : 0,
  "msg" : "success"
}

Status Codes

Status Code

Description

200

Return to shared folder details.