Help Center/ KooDrive/ API Reference/ API/ Sharing Management - Shared by You/ Obtaining Sharing Details
Updated on 2026-02-12 GMT+08:00
View PDF
Share

Obtaining Sharing Details

Function

Obtain sharing details.

Authorization Information

No identity policy-based permission required for calling this API.

URI

GET /koodrive/ose/v1/share/{shareId}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

shareId

Yes

String

Sharing ID.

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

Service trace ID, which contains 58 bits.

X-User-Id

Yes

String

User ID, which is used for app authentication.

X-Date

Yes

String

Date, which is used for app authentication.

Host

Yes

String

Address, which is used for app authentication.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

String

Response code.

msg

String

Response information.

shareLink

ShareByMeLinkDetail object

Details about the sharing link.
Table 4 ShareByMeLinkDetail

Parameter

Type

Description

shareId

String

Sharing ID.

shortUrl

String

Sharing short code.

linkUrl

String

Sharing link.

shareTime

String

Time when the file is shared.

scope

Integer

Sharing scope. 1: users who receive the link (only for whitelisted users); 2: only enterprise users; 3: specified enterprise users.

depts

Array of DeptInfo objects

Department list.

groups

Array of GroupInfo objects

User group list.

users

Array of UserInfo objects

User list.

displayName

String

Display name.

permission

SharePermission object

Sharing permission (supported in the future).

extractCode

String

Access code.

expireTime

String

Expiration time.

status

Integer

Sharing status. 0: determined based on the expiration time. 1: The file has been deleted. 2: expired.

comment

String

Sharing message.
Table 5 DeptInfo

Parameter

Type

Description

id

String

Department ID.

name

String

Department name.
Table 6 GroupInfo

Parameter

Type

Description

id

String

User group ID.

name

String

User group name.
Table 7 UserInfo

Parameter

Type

Description

id

String

User ID.

name

String

Username.
Table 8 SharePermission

Parameter

Type

Description

preview

Boolean

Preview permission.

edit

Boolean

Editing permission.

download

Boolean

Download permission.

Example Requests

GET /koodrive/ose/v1/share/{shareId}

Authorization:Bearer+10f88*************5a544791e9ff

Example Responses

Status code: 200

OK

{
  "code" : "string",
  "msg" : "string",
  "shareLink" : {
    "shareId" : "string",
    "shortUrl" : "string",
    "linkUrl" : "string",
    "shareTime" : "2024-06-03T01:59:05.324Z",
    "scope" : 0,
    "depts" : [ {
      "id" : "string",
      "name" : "string"
    } ],
    "groups" : [ {
      "id" : "string",
      "name" : "string"
    } ],
    "users" : [ {
      "id" : "string",
      "name" : "string"
    } ],
    "displayName" : "string",
    "permission" : {
      "preview" : true,
      "edit" : true,
      "download" : true
    },
    "extractCode" : "string",
    "expireTime" : "2024-06-03T01:59:05.324Z",
    "status" : 0,
    "comment" : "string"
  }
}

Status Codes

Status Code

Description

200

OK