Get user shared folders

GET 
/shares

Get a listing of user folder/document shares; available as an Add-On Module

Request

Query Parameters

group string

Group Identifier

limit string
Limit Results
Default value: 10
next string

Next page of results token

Responses

200

200 OK

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

next string

Next page of results token

shares

object[]

List of user's shares

Array [

group string

Name of Share Group

shareKey string

Share Identifier

type string

Type of Document

Possible values: [FOLDER]

permissions UserSharePermission (string)[]

List of share permissions

Possible values: [READ, WRITE, DELETE]

siteId string

Site Identifier

path string

Path or Name of document

userId string

User who created share

permissionType UserSharePermissionType (string)

User Share Permission Type

Possible values: [GROUP]

]

Example (from schema)

{
  "next": "string",
  "shares": [
    {
      "group": "string",
      "shareKey": "string",
      "type": "FOLDER",
      "permissions": [
        "READ"
      ],
      "siteId": "string",
      "path": "string",
      "userId": "string",
      "permissionType": "GROUP"
    }
  ]
}

Loading...