GET/users/{userId}/drive/sharedfolders/{sharedFolderId}/files

Gets a list of root files in a shared folder.

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/{sharedFolderId}/files

Path Parameters

ParameterTypeDescription
userId string 

User ID

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

required
example : me 
sharedFolderId string 

Shared folder ID


required
example : MTIzNDVfRF8xMjM0NQ 

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
files array (File) 

File information

 
responseMetaData object (responseMetaData) 

Response metadata

 

File

PropertyTypeDescription
accessedTime string 

Access date


readOnly : true 
createdTime string 

Creation date


readOnly : true 
fileId string 

File ID


readOnly : true 
parentFileId string 

File ID of the parent folder


readOnly : true 
fileName string 

File name


readOnly : true 
fileSize integer 

File size


format : int64
readOnly : true 
filePath string 

File path


readOnly : true 
fileType string 

File type

  • AUDIO: Audio file
  • DOC: Document file
  • ETC: Etc. file
  • EXE: Executable file
  • FOLDER: Folder
  • IMAGE: Image file
  • VIDEO: Video file
  • ZIP: Zip file

Allowed values : AUDIO, DOC, ETC, EXE, FOLDER, IMAGE, VIDEO, ZIP 
hasPermission boolean 

Indicates whether an access permission is set for the file.


readOnly : true 
permissionRootFileId string 

Permission root folder ID


readOnly : true
nullable : true 
shared boolean 

Indicates whether the file is shared.


readOnly : true
nullable : false 
shareRootFileId string 

Root folder ID of the shared folder


readOnly : true
nullable : true 
resourceLocation integer 

Resource location code


format : int32
readOnly : true 
statuses array (ENUM_FileStatus) 

File status

 
modifiedTime string 

Update date


readOnly : true 

ENUM_FileStatus

PropertyTypeDescription
ENUM_FileStatus string 

File status

  • LOCKED: Locked file
  • MALWARE: Malware file
  • PROTECTED: File marked as Important
  • IN_PROGRESS: File being uploaded

Allowed values : LOCKED, MALWARE, PROTECTED, IN_PROGRESS 

responseMetaData

PropertyTypeDescription
nextCursor string 

Cursor value for pagination


readOnly : true 

Response Example

example

1{2  "files": [3    {4      "fileId": "QDIxMDAwMDAwMDAwMTcwfDExODE1MDg3MzQ0NzJ8RHww",5      "parentFileId": "QDIxMDAwMDAwMDAwMTcwfDExNzgyODY2MjgxMDR8RHww",6      "resourceLocation": 24101,7      "fileSize": 10,8      "fileName": "works.txt",9      "filePath": "/works.txt",10      "fileType": "DOC",11      "createdTime": "2020-11-13T18:20:05.05+09:00",12      "modifiedTime": "2021-04-05T21:14:05.05+09:00",13      "accessedTime": "2021-04-05T21:14:05.05+09:00",14      "statuses": [],15      "hasPermission": false,16      "permissionRootFileId": null,17      "shared": false,18      "shareRootFileId": null19    },20    {21      "fileId": "NzExNTMwMDF8MTQ2NzA1NjAxMDAwMHxGfDA",22      "parentFileId": "QDIxMDAwMDAwMDAwMTcwfDExNzgyODY2MjgxMDR8RHww",23      "resourceLocation": 24101,24      "fileSize": 0,25      "fileName": "worksFolder",26      "filePath": "/worksFolder/",27      "fileType": "FOLDER",28      "createdTime": "2020-11-13T18:20:05.05+09:00",29      "modifiedTime": "2021-04-05T21:14:05.05+09:00",30      "accessedTime": "2021-04-05T21:14:05.05+09:00",31      "statuses": [],32      "hasPermission": false,33      "permissionRootFileId": null,34      "shared": false,35      "shareRootFileId": null36    }37  ],38  "responseMetaData": {39    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="40  }41}

HTTP 400

Invalid parameters received.

HTTP 403

Access is denied: no permission.

HTTP 404

Resource does not exist.