Skip to main content
Documentation

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

NameData TypeDescription
scopestringFilter 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.
usernamestringOnly 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.
namestringUsed for filtering results whose description includes the given text.
offsetintegerUsed for paginating responses. Skip this number of results.
limitintegerUsed for paginating responses. Limit the total number of returned results.
sortstringHow to sort the returned results.
Possible values: created or -created

Pagination

The legacy ExaVault API does not support cursor-based pagination. Use the limit and offset request parameters to restrict the number of results returned, and make multiple requests to retrieve subsequent pages.

The limit parameter sets the maximum number of results returned, starting from the beginning of the list or from the offset value when provided. limit cannot exceed 10,000.

The offset parameter sets how many records to skip before returning up to limit results.

Sorting

Use the sort parameter to control the order of returned results. Valid values are created and -created.

created returns records in ascending order (oldest to newest). -created (prefixed with -, a minus or hyphen) returns records in descending order (newest to oldest).