GET/users/{userId}/drive/favorites

Get favorite folder list.

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/favorites

Path Parameters

ParameterTypeDescription
userId string 

User ID

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

required
example : me 

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 
modifiedTime string 

Update 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
nullable : false 
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 (FileStatus) 

File status


Allowed values : LOCKED, MALWARE, PROTECTED, IN_PROGRESS 
driveInfo object (driveInfo) 

Drive information for File

 

FileStatus

PropertyTypeDescription
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 

driveInfo

PropertyTypeDescription
driveType string 

Drive Type

  • MY_DRIVE: My Drive
  • SHARED_FOLDER: Shared Folder
  • SHARE_DRIVE: Collaborative Drive
  • CHANNEL_FOLDER: Team/Group/Channel Folder

Allowed values : MY_DRIVE, SHARED_FOLDER, SHARE_DRIVE, CHANNEL_FOLDER 
id string 

ID corresponding to Drive Type


readOnly : true
nullable : true 

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": "/ShareDriveName/works.txt",10      "fileType": "DOC",11      "createdTime": "2020-11-13T18:20:05+09:00",12      "modifiedTime": "2021-04-05T21:14:05+09:00",13      "accessedTime": "2021-04-05T21:14:05+09:00",14      "statuses": [],15      "hasPermission": false,16      "permissionRootFileId": null,17      "driveInfo": {18        "driveType": "SHARE_DRIVE",19        "id": "@248080202002"20      }21    },22    {23      "fileId": "MTU1NzYwMDF8MzQ3MjQ3MTI0MDkxNzYzNTMzN3xEfDA",24      "parentFileId": "MTU1NzYwMDF8MzQ3MjQ3MTI0MDY1MTQxMTcyMHxEfDA",25      "resourceLocation": 24101,26      "fileSize": 0,27      "fileName": "worksFolder",28      "filePath": "/GroupFolderName/worksFolder/",29      "fileType": "FOLDER",30      "createdTime": "2020-11-13T18:20:05+09:00",31      "modifiedTime": "2021-04-05T21:14:05+09:00",32      "accessedTime": "2021-04-05T21:14:05+09:00",33      "statuses": [],34      "hasPermission": false,35      "permissionRootFileId": null,36      "driveInfo": {37        "driveType": "CHANNEL_FOLDER",38        "id": "@93000099002912"39      }40    }41  ],42  "responseMetaData": {43    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="44  }45}