List Shares
Summary
Get a list of Share Links.
Endpoint
GET https://mysite.files.com/api/v2/shares
Replace mysite.files.com with your site address.
Request Parameters
| Name | Data Type | Description |
|---|---|---|
scope | string | Filter the list of shares to return. Valid options are active or currentUser.The active scope returns only shares that are currently active. The currentUser scope returns only shares that are created by you. |
username | string | Only shares created by the user with the given username will be included in the list. Only users with admin rights can see shares created by another user. |
name | string | Used for filtering results whose description includes the given text. |
offset | integer | Used for paginating responses. Skip this number of results. |
limit | integer | Used for paginating responses. Limit the total number of returned results. |
sort | string | How to sort the returned results. Possible values: created or -created |
Pagination
The legacy ExaVault API does not include cursor-based pagination. Instead, you can use the limit and offset request parameters to restrict the number of results returned, and make multiple requests to retrieve subsequent pages of results.
The limit parameter is the maximum number of results that can be returned, starting from the beginning of the list or from the offset parameter value, if that was provided. The value of limit cannot be larger than 10,000.
The offset parameter represents how many records to skip before returning up to limit number of results.
Sorting
You can specify what order the results will be returned in by using the sort parameter. Valid options are created or -created.
Choosing to sort by created returns records in ascending order (oldest to newest). Using -created (prefixed with -, a minus/hyphen character) returns records in descending order (from newest to oldest).