- Home
- Resources
- Sharing
POST /shares
Notify share recipients without modifying the shares.
For public_link
share recipients, the notify_address
form parameter can be used to specify
email addresses to notify of the public link.
Request Parameters
name |
type |
description |
default |
constraints |
multivalued |
id |
form |
ID of a share. May be specified multiple times. |
|
long |
yes |
notify |
form |
If true, the recipients will be notified. |
false |
boolean |
no |
notify_address |
form |
An email address to send a public link to. May be specified multiple times. |
|
|
yes |
GET /shares/by_user/{id}
Get the shares where the specified user is the sharer.
Request Parameters
name |
type |
description |
constraints |
id |
path |
The ID of the user |
long |
Response Body
media type |
data type |
description |
application/json |
SearchResultList
(JSON) |
A SearchResultList of Share objects. |
application/xml |
searchResultList
(XML) |
GET /shares/by_user/{id}/library_changes
Get changes to files and folders that have occurred in the user's Share by Me folder since the specified date.
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
The ID of the folder. |
|
long |
count |
query |
The maximum number of changes to return. |
500 |
int |
description_format |
query |
The desired format for descriptions. Can be "html" or "text". |
text |
|
hidden |
query |
|
false |
boolean |
recursive |
query |
Whether to return changes in the immediate folder only (false) or all subfolders (true). |
true |
boolean |
since |
query |
UTC date and time in ISO 8601 format. For example, 2016-03-05T06:24:57Z. |
|
|
unhidden |
query |
|
true |
boolean |
Response Codes
code |
condition |
409 |
The changes cannot be determined. |
Response Body
media type |
data type |
description |
application/json |
BinderChanges
(JSON) |
A BinderChanges resource. |
application/xml |
binderChanges
(XML) |
GET /shares/by_user/{id}/library_children
List the files and folders shared by the specified user..
The title
query parameter limits the results to those children with the specified name. Wildcards are not supported.
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
The ID of the user. |
|
long |
hidden |
query |
Whether to include hidden shares in the results. |
false |
boolean |
title |
query |
The name of the child to return, |
|
|
unhidden |
query |
Whether to include unhidden, or visible, shares in the results. |
true |
boolean |
Response Body
media type |
data type |
description |
application/json |
object
(JSON) |
A SearchResultList of SearchableObjects (SharedBinderBriefs and SharedFileProperties). |
application/xml |
anyType
(XML) |
GET /shares/by_user/{id}/library_entities
Search files and folder shared by the specified user for entities by keyword.
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
The user ID. |
|
long |
binders |
query |
Whether to include binders in the results. |
true |
boolean |
count |
query |
The maximum number of results to return. |
100 |
int |
description_format |
query |
The desired format for the binder description. Can be "html" or "text". |
text |
|
files |
query |
Whether to include files in the results. |
true |
boolean |
first |
query |
The index of the first result to return. |
0 |
int |
folder_entries |
query |
Whether to include folder entries in the results. |
true |
boolean |
hidden |
query |
Whether to include files and folders that have been hidden by the user. |
false |
boolean |
keyword |
query |
A search term. May include wildcards, but cannot begin with a wildcard. For example, "keyword=D*d" is
allowed but "keyword=*d" is not. |
|
|
parent_binder_paths |
query |
Whether to include the parent binder path with each entity. |
false |
boolean |
recursive |
query |
Whether to search the immediate folder (false) or all subfolders (true). |
false |
boolean |
replies |
query |
Whether to include replies in the results. |
true |
boolean |
unhidden |
query |
Whether to include files and folders that have been not been hidden by the user. |
true |
boolean |
Response Body
media type |
data type |
description |
application/json |
SearchResultList
(JSON) |
A SearchResultList of SearchableObject resources (BinderBrief, FolderEntryBrief, FileProperties, ReplyBrief). |
application/xml |
searchResultList
(XML) |
GET /shares/by_user/{id}/library_files
List the files shared by the specified user.
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
The ID of the user. |
|
long |
file_name |
query |
The name of the child to return, |
|
|
hidden |
query |
Whether to include hidden shares in the results. |
false |
boolean |
parent_binder_paths |
query |
If true, the path of the parent binder is included in each result. |
false |
boolean |
recursive |
query |
Whether to search the binder and sub-binders for files. |
false |
boolean |
unhidden |
query |
Whether to include unhidden, or visible, shares in the results. |
true |
boolean |
Response Body
media type |
data type |
description |
application/json |
object
(JSON) |
A SearchResultList of SearchableObjects (SharedBinderBriefs and SharedFileProperties). |
application/xml |
anyType
(XML) |
GET /shares/by_user/{id}/recent_activity
List recently changed folder entries shared by the specified user.
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
The ID of the user. |
|
long |
count |
query |
The maximum number of results to return. |
20 |
int |
description_format |
query |
The desired format for the folder entry description. Can be "html" or "text". |
text |
|
first |
query |
The index of the first result to return. |
0 |
int |
hidden |
query |
Whether to include hidden shares in the results. |
false |
boolean |
parent_binder_paths |
query |
Whether to include the parent binder path with each entry. |
false |
boolean |
unhidden |
query |
Whether to include unhidden, or visible, shares in the results. |
true |
boolean |
Response Body
media type |
data type |
description |
application/json |
SearchResultList
(JSON) |
A SearchResultList of RecentActivityEntry resources. |
application/xml |
searchResultList
(XML) |
GET /shares/public
Get the shares where the recipient is public.
Response Body
media type |
data type |
description |
application/json |
SearchResultList
(JSON) |
A SearchResultList of Share objects. |
application/xml |
searchResultList
(XML) |
GET /shares/public/library_changes
Get changes to files and folders that have occurred in the Public top-level folder since the specified date.
Request Parameters
name |
type |
description |
default |
constraints |
count |
query |
The maximum number of changes to return. |
500 |
int |
description_format |
query |
The desired format for descriptions. Can be "html" or "text". |
text |
|
hidden |
query |
|
false |
boolean |
recursive |
query |
Whether to return changes in the immediate folder only (false) or all subfolders (true). |
true |
boolean |
since |
query |
UTC date and time in ISO 8601 format. For example, 2016-03-05T06:24:57Z. |
|
|
unhidden |
query |
|
true |
boolean |
Response Codes
code |
condition |
409 |
The changes cannot be determined. |
Response Body
media type |
data type |
description |
application/json |
BinderChanges
(JSON) |
A BinderChanges resource. |
application/xml |
binderChanges
(XML) |
GET /shares/public/library_children
List the files and folders shared publicly.
The title
query parameter limits the results to those children with the specified name. Wildcards are not supported.
Request Parameters
name |
type |
description |
default |
constraints |
hidden |
query |
Whether to include hidden shares in the results. |
false |
boolean |
title |
query |
The name of the child to return, |
|
|
unhidden |
query |
Whether to include unhidden, or visible, shares in the results. |
true |
boolean |
Response Body
media type |
data type |
description |
application/json |
object
(JSON) |
A SearchResultList of SearchableObjects (SharedBinderBriefs and SharedFileProperties). |
application/xml |
anyType
(XML) |
GET /shares/public/library_entities
Search files and folder shared publicly for entities by keyword.
Request Parameters
name |
type |
description |
default |
constraints |
binders |
query |
Whether to include binders in the results. |
true |
boolean |
count |
query |
The maximum number of results to return. |
100 |
int |
description_format |
query |
The desired format for the binder description. Can be "html" or "text". |
text |
|
files |
query |
Whether to include files in the results. |
true |
boolean |
first |
query |
The index of the first result to return. |
0 |
int |
folder_entries |
query |
Whether to include folder entries in the results. |
true |
boolean |
hidden |
query |
Whether to include files and folders that have been hidden by the user. |
false |
boolean |
keyword |
query |
A search term. May include wildcards, but cannot begin with a wildcard. For example, "keyword=D*d" is
allowed but "keyword=*d" is not. |
|
|
parent_binder_paths |
query |
Whether to include the parent binder path with each entity. |
false |
boolean |
recursive |
query |
Whether to search the immediate folder (false) or all subfolders (true). |
false |
boolean |
replies |
query |
Whether to include replies in the results. |
true |
boolean |
unhidden |
query |
Whether to include files and folders that have been not been hidden by the user. |
true |
boolean |
Response Body
media type |
data type |
description |
application/json |
SearchResultList
(JSON) |
A SearchResultList of SearchableObject resources (BinderBrief, FolderEntryBrief, FileProperties, ReplyBrief). |
application/xml |
searchResultList
(XML) |
GET /shares/public/library_files
List the files shared publicly.
Request Parameters
name |
type |
description |
default |
constraints |
file_name |
query |
The name of the child to return, |
|
|
hidden |
query |
Whether to include hidden shares in the results. |
false |
boolean |
parent_binder_paths |
query |
If true, the path of the parent binder is included in each result. |
false |
boolean |
recursive |
query |
Whether to search the binder and sub-binders for files. |
false |
boolean |
unhidden |
query |
Whether to include unhidden, or visible, shares in the results. |
true |
boolean |
Response Body
media type |
data type |
description |
application/json |
object
(JSON) |
A SearchResultList of SearchableObjects (SharedBinderBriefs and SharedFileProperties). |
application/xml |
anyType
(XML) |
GET /shares/public/library_folders
List the folders shared publicly.
The title
query parameter limits the results to those folders with the specified name. Wildcards are not supported.
Request Parameters
name |
type |
description |
default |
constraints |
hidden |
query |
Whether to include hidden shares in the results. |
false |
boolean |
title |
query |
The name of the child to return, |
|
|
unhidden |
query |
Whether to include unhidden, or visible, shares in the results. |
true |
boolean |
Response Body
media type |
data type |
description |
application/json |
object
(JSON) |
A SearchResultList of SearchableObjects (SharedBinderBriefs and SharedFileProperties). |
application/xml |
anyType
(XML) |
GET /shares/public/library_tree
Get a tree structure representing the folder structure contained in the Public top-level folder.
Request Parameters
name |
type |
description |
default |
constraints |
description_format |
query |
The desired format for the binder descriptions. Can be "html" or "text". |
text |
|
hidden |
query |
Whether to include hidden shares in the results. |
false |
boolean |
unhidden |
query |
Whether to include unhidden, or visible, shares in the results. |
true |
boolean |
Response Body
media type |
data type |
description |
application/json |
BinderTree
(JSON) |
A BinderTree |
application/xml |
binderTree
(XML) |
GET /shares/public/recent_activity
List recently changed folder entries shared publicly.
Request Parameters
name |
type |
description |
default |
constraints |
count |
query |
The maximum number of results to return. |
20 |
int |
description_format |
query |
The desired format for the folder entry description. Can be "html" or "text". |
text |
|
first |
query |
The index of the first result to return. |
0 |
int |
hidden |
query |
Whether to include hidden shares in the results. |
false |
boolean |
parent_binder_paths |
query |
Whether to include the parent binder path with each entry. |
false |
boolean |
unhidden |
query |
Whether to include unhidden, or visible, shares in the results. |
true |
boolean |
Response Body
media type |
data type |
description |
application/json |
SearchResultList
(JSON) |
A SearchResultList of RecentActivityEntry resources. |
application/xml |
searchResultList
(XML) |
GET /shares/with_user/{id}
Get the shares where the specified user is the recipient.
Request Parameters
name |
type |
description |
constraints |
id |
path |
The ID of the user |
long |
Response Body
media type |
data type |
description |
application/json |
SearchResultList
(JSON) |
A SearchResultList of Share objects. |
application/xml |
searchResultList
(XML) |
GET /shares/with_user/{id}/library_changes
Get changes to files and folders that have occurred in the user's Share with Me folder since the specified date.
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
The ID of the folder. |
|
long |
count |
query |
The maximum number of changes to return. |
500 |
int |
description_format |
query |
The desired format for descriptions. Can be "html" or "text". |
text |
|
hidden |
query |
|
false |
boolean |
recursive |
query |
Whether to return changes in the immediate folder only (false) or all subfolders (true). |
true |
boolean |
since |
query |
UTC date and time in ISO 8601 format. For example, 2016-03-05T06:24:57Z. |
|
|
unhidden |
query |
|
true |
boolean |
Response Codes
code |
condition |
409 |
The changes cannot be determined. |
Response Body
media type |
data type |
description |
application/json |
BinderChanges
(JSON) |
A BinderChanges resource. |
application/xml |
binderChanges
(XML) |
GET /shares/with_user/{id}/library_children
List the files and folders shared with the specified user.
The title
query parameter limits the results to those children with the specified name. Wildcards are not supported.
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
The ID of the user. |
|
long |
hidden |
query |
Whether to include hidden shares in the results. |
false |
boolean |
title |
query |
The name of the child to return, |
|
|
unhidden |
query |
Whether to include unhidden, or visible, shares in the results. |
true |
boolean |
Response Body
media type |
data type |
description |
application/json |
object
(JSON) |
A SearchResultList of SearchableObjects (BinderBriefs and FileProperties). |
application/xml |
anyType
(XML) |
GET /shares/with_user/{id}/library_entities
Search files and folder shared with the specified user for entities by keyword.
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
The user ID. |
|
long |
binders |
query |
Whether to include binders in the results. |
true |
boolean |
count |
query |
The maximum number of results to return. |
100 |
int |
description_format |
query |
The desired format for the binder description. Can be "html" or "text". |
text |
|
files |
query |
Whether to include files in the results. |
true |
boolean |
first |
query |
The index of the first result to return. |
0 |
int |
folder_entries |
query |
Whether to include folder entries in the results. |
true |
boolean |
hidden |
query |
Whether to include files and folders that have been hidden by the user. |
false |
boolean |
keyword |
query |
A search term. May include wildcards, but cannot begin with a wildcard. For example, "keyword=D*d" is
allowed but "keyword=*d" is not. |
|
|
parent_binder_paths |
query |
Whether to include the parent binder path with each entity. |
false |
boolean |
recursive |
query |
Whether to search the immediate folder (false) or all subfolders (true). |
false |
boolean |
replies |
query |
Whether to include replies in the results. |
true |
boolean |
unhidden |
query |
Whether to include files and folders that have been not been hidden by the user. |
true |
boolean |
Response Body
media type |
data type |
description |
application/json |
SearchResultList
(JSON) |
A SearchResultList of SearchableObject resources (BinderBrief, FolderEntryBrief, FileProperties, ReplyBrief). |
application/xml |
searchResultList
(XML) |
GET /shares/with_user/{id}/library_files
List the files shared with the specified user.
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
The ID of the user. |
|
long |
file_name |
query |
The name of the child to return, |
|
|
hidden |
query |
Whether to include hidden shares in the results. |
false |
boolean |
parent_binder_paths |
query |
If true, the path of the parent binder is included in each result. |
false |
boolean |
recursive |
query |
Whether to search the binder and sub-binders for files. |
false |
boolean |
unhidden |
query |
Whether to include unhidden, or visible, shares in the results. |
true |
boolean |
Response Body
media type |
data type |
description |
application/json |
object
(JSON) |
A SearchResultList of SearchableObjects (SharedBinderBriefs and SharedFileProperties). |
application/xml |
anyType
(XML) |
GET /shares/with_user/{id}/library_tree
Get a tree structure representing the folder structure contained the user's Share with Me folder.
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
The ID of the user. |
|
long |
description_format |
query |
The desired format for the binder descriptions. Can be "html" or "text". |
text |
|
hidden |
query |
Whether to include hidden shares in the results. |
false |
boolean |
unhidden |
query |
Whether to include unhidden, or visible, shares in the results. |
true |
boolean |
Response Body
media type |
data type |
description |
application/json |
BinderTree
(JSON) |
A BinderTree |
application/xml |
binderTree
(XML) |
GET /shares/with_user/{id}/recent_activity
List recently changed folder entries shared with the specified user.
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
The ID of the user. |
|
long |
count |
query |
The maximum number of results to return. |
20 |
int |
description_format |
query |
The desired format for the folder entry description. Can be "html" or "text". |
text |
|
first |
query |
The index of the first result to return. |
0 |
int |
hidden |
query |
Whether to include hidden shares in the results. |
false |
boolean |
parent_binder_paths |
query |
Whether to include the parent binder path with each entry. |
false |
boolean |
unhidden |
query |
Whether to include unhidden, or visible, shares in the results. |
true |
boolean |
Response Body
media type |
data type |
description |
application/json |
SearchResultList
(JSON) |
A SearchResultList of RecentActivityEntry resources. |
application/xml |
searchResultList
(XML) |
DELETE /shares/{id}
Delete the specified Share.
Request Parameters
name |
type |
description |
constraints |
id |
path |
The ID of the share. |
long |
GET /shares/{id}
Get the specified Share object.
Request Parameters
name |
type |
description |
constraints |
id |
path |
The ID of the share. |
long |
Response Body
media type |
data type |
description |
application/json |
Share
(JSON) |
A Share object. |
application/xml |
share
(XML) |
POST /shares/{id}
Overwrite the specified share. This will not modify the Share's shared entity or recipient.
The share will be assigned a new ID. The returned Share object contains the new ID.
Request Parameters
name |
type |
description |
default |
constraints |
multivalued |
id |
path |
The ID of the share to overwrite. |
|
long |
no |
notify |
query |
If true, the recipient will be notified by email. |
false |
boolean |
no |
notify_address |
query |
An email address to notify, if the recipient type is public_link . May be specified multiple times. |
|
|
yes |
Request Body
media type |
data type |
description |
application/json |
Share
(JSON) |
A Share object containing the new share settings. |
application/xml |
share
(XML) |
Response Body
media type |
data type |
description |
application/json |
Share
(JSON) |
The update SHare object. |
application/xml |
share
(XML) |