a1bd874b5960
Get a list of shares
Get a list of shares that you would have access to view through the web interface. You can limit which results are returned by specifying specific types of shares you wish to view, finding things shared with a specific email address, as well as finding shares for specific folder names.
Notes:
- Authenticated user requires share permission.
- To get share objects with type send, authenticated user's role must be admin or master.
Query parameters
Current offset of records (for pagination)
Limit of records to be returned (for pagination)
Set of shares to return. (all=all of them, active=shares that are currently active, curentUser=shares created by you)
What order the list of matches should be in.
Limit the list of matches to only certain types of shares.
Comma separated list of relationships to include in response. Possible values are owner, resources, notifications, activity.
When provided, only shares whose names include this value will be in the list. Supports wildcards, such as send* to return everything starting with "send".
Use this parameter if you are searching for shares or receives for a specific folder name. For example /Clients/ACME/To Be Processed.
Filter the results to include only shares that invited a certain email address. Supports wildcard matching so that *@example.com will give back entries shared with addresses ending in "@example.com".
When provided, only shares with a message that contains the text will be included in the list of matches. Both the subject and the body of all messages will be checked for matches. This will always be a wildcard match, so that searching for taxes will return any shares with a message that contains the word "taxes".
When provided, only shares created by the user with that username will be included in the list. Does not support wildcard searching.
Searches the share name, username, recipients, share messages fields for the provided value. Supports wildcard searches.
Headers
API Key required to make the API call.
Access token required to make the API call.
Response
Successful operation