GET/users/{userId}/drive/sharedfolders

Gets a list of shared folders.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

file
file.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}/drive/sharedfolders

Path Parameters

ParameterTypeDescription
userId string 

User ID

  • Mail
  • Resource ID
  • External key in "externalKey:{externalKey}" format
  • me

required
example : me 

Query Parameters

ParameterTypeDescription
count integer 

Number of items to get


default : 20
minimum : 1
maximum : 200
example : 20
format : int32 
cursor string 

Cursor


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA==
allowReserved : false 
orderBy string 

Sort method. Use a blank space (%20) to separate "sort by" and "sort order." Example) createdTime%20desc

  • Sort by
    • Files: createdTime, modifiedTime, accessedTime, fileExtension, fileName, filePath, fileSize, fileType, protect
    • Trashed files: deletedTime, fileSize, fileType, fileName, originalPath
  • Sort order
    • asc: Ascending order
    • desc: Descending order

example : createdTime%20desc 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
responseMetaData object (responseMetaData) 

Response metadata

 
result array (object) 
 

responseMetaData

PropertyTypeDescription
nextCursor string 

Cursor value for pagination


readOnly : true 

object

PropertyTypeDescription
sharedFolderId string 

Shared folder ID


readOnly : true 
sharedFolderName string 

Shared folder name


readOnly : true 
ownerId string 

Owner ID


readOnly : true 
ownerName string 

Owner name


readOnly : true 
rootFileId string 

Root file ID


readOnly : true 
createdTime string 

Creation time


format : date-time
readOnly : true 
modifiedTime string 

Update time


format : date-time
readOnly : true 
resourceLocation integer 

Resource location code


format : int32
readOnly : true 
permissionType string 

Permission type

  • READ: Read permission
  • WRITE: Write permission

Allowed values : READ, WRITE 
useRevision boolean 

Indicates whether to use revisions.


readOnly : true 
protected boolean 

Indicates whether to mark the file as Important.


readOnly : true 

Response Example

example

1{2  "responseMetaData": {3    "nextCursor": "TlRnd09UQXdORjlFWHprek9Ea3lPRFUyTWpRek5nfGRlIHdhbnRzIHRvIHNoYXJl"4  },5  "sharedFolders": [6    {7      "sharedFolderId": "NTgwOTAwNF9EXzkzODkyODU2MjQzNg",8      "sharedFolderName": "share",9      "ownerId": "userf7da-f82c-4284-13e7-030f3b4c756x",10      "ownerName": "ownerName",11      "rootFileId": "NTgwOTAwNHw5Mzg5Mjg1NjI0MzZ8RHwxNzQ",12      "createdTime": "2023-07-06T16:27:28+09:00",13      "modifiedTime": "2023-07-06T16:27:28+09:00",14      "resourceLocation": 11551,15      "permissionType": "WRITE",16      "useRevision": true,17      "protected": false18    }19  ]20}