Listing Files Shared with You

Updated on 2025-03-07 GMT+08:00

View PDF

Function

List files shared with you.

URI

GET /koodrive/ose/v1/share/received

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
pageSize	No	Integer	Number of records to be returned on each page. Default and maximum value: 100. It is possible that partial or empty result pages are returned before the end of the result list has been reached.
pageCursor	No	String	Current page cursor, which is obtained from nextCursor of the previous response. Default value: 0.
sortType	No	Integer	Sorting type. 4: by sharing time (default).
sortDirection	No	Integer	Sorting order. 1: ascending; 2: descending (default).
displayName	No	String	Fuzzy match by display name is supported.
imageProcess	No	String	Image operation, which can be used to specify the thumbnail size.

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	Integer	Response code.
msg	String	Response information.
nextCursor	String	Pagination cursor. If the cursor does not exist, the last record has been returned.
shareLinks	Array of ShareWithMeLink objects	Sharing link list.

**Table 4** ShareWithMeLink
Parameter	Type	Description
shareId	String	Sharing ID.
shortUrl	String	Sharing short code.
linkUrl	String	Sharing link.
shareTime	String	Time when the file is shared.
ownerId	String	Sharer ID.
ownerName	String	Sharer name.
displayName	String	Display name.
files	Array of ShareFileInfo objects	List of shared files.
permission	SharePermission object	Sharing permission (supported in the future).
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.
containerId	String	Space ID.
downloadCnt	Integer	Download times.
saveCnt	Integer	Save times.
scope	String	Scope.
updateTime	String	Update time.
viewCnt	String	Number of views.

**Table 5** ShareFileInfo
Parameter	Type	Description
id	String	*File ID.
fileName	String	*File name, which contains up to 160 bytes.
fileType	String	File type, which is entered externally. The value contains up to 250 characters.
mimeType	String	*Content type.
size	Integer	File size.
parentFolder	Array of strings	List of parent directory IDs. Currently, only the first ID is used.
fileSuffix	String	File name extension, which is the last character string of fullFileExtension.
containers	Array of strings	Space ID.
downloadLinks	Array of downloadLinks objects	Download link.
recycled	Boolean	Whether the file is in the recycle bin.

**Table 6** downloadLinks
Parameter	Type	Description
usage	String	Default usage: content or thumbnail. This parameter is customizable.
downloadLink	String	Download link.

**Table 7** SharePermission
Parameter	Type	Description
preview	Boolean	Preview permission.
edit	Boolean	Editing permission.
download	Boolean	Download permission.

Example Requests

GET /koodrive/ose/v1/share/received?pageSize=&pageCursor=0&sortType=2&sortDirection=4&displayName=&tenantId=String

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

Example Responses

Status code: 200

{
  "code" : "string",
  "msg" : "string",
  "nextCursor" : "string",
  "shareLinks" : [ {
    "shareId" : "string",
    "shortUrl" : "string",
    "linkUrl" : "string",
    "shareTime" : "2024-06-03T02:02:00.797Z",
    "ownerId" : "string",
    "ownerName" : "string",
    "displayName" : "string",
    "files" : [ {
      "id" : "string",
      "fileName" : "string",
      "fileType" : "string",
      "mimeType" : "string",
      "size" : 0,
      "parentFolder" : [ "string" ],
      "fileSuffix" : "string",
      "containers" : [ "string" ]
    } ],
    "permission" : {
      "preview" : true,
      "edit" : true,
      "download" : true
    },
    "expireTime" : "2024-06-03T02:02:00.797Z",
    "status" : 0,
    "comment" : "string"
  } ]
}