Folders Collaboration

Get Folder Group Collaborator

Retrieves information about a group's direct collaborator access to a given folder. A group having access to a folder through one of the folder's ancestors will not be shown through this API.

get/v1/folders/{id}/shares/groups/{groupId}

Request

  • Base URL: https://api.lucid.co
  • URL: https://api.lucid.co/v1/folders/{id}/shares/groups/{groupId}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://lucid.app/oauth2/authorize, token URL https://api.lucid.co/oauth2/token, scopes: folder, folder:readonly)

Path parameters

idnumber required

Folder ID.

groupIdnumber required

Group ID.

Response

OK with a Folder Group Collaborator Resource containing information about the group's collaboration access on the folder.

folderIdinteger required

Folder ID

groupIdinteger required

Group ID

role'owner' | 'editandshare' | 'edit' | 'comment' | 'view' required

The Collaborator Role on the document or folder

createdstring date-time required

Date and time when the collaboration was created

Changes

No recorded changes to this operation across all 1 revision of this API.