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

Gets the information of 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}

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 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

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  "sharedFolderId": "NTgwOTAwNF9EXzkzODkyODU2MjQzNg",3  "sharedFolderName": "share",4  "ownerId": "userf7da-f82c-4284-13e7-030f3b4c756x",5  "ownerName": "ownerName",6  "rootFileId": "NTgwOTAwNHw5Mzg5Mjg1NjI0MzZ8RHwxNzQ",7  "createdTime": "2023-07-06T16:27:28+09:00",8  "modifiedTime": "2023-07-06T16:27:28+09:00",9  "resourceLocation": 11551,10  "permissionType": "WRITE",11  "useRevision": true,12  "protected": false13}

HTTP 403

Access is denied: no permission.

HTTP 404

Shared folder or permission does not exist.