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 "current User".
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 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 limit cannot be larger than 10,000.

The offset represents how many records to skip before returning up to the limit parameter value 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 from oldest to newest. Using "-created" returns records from newest to oldest.

Get Instant Access to Files.com

The button below will take you to our Free Trial signup page. Click on the white "Start My Free Trial" button, then fill out the short form on the next page. Your account will be activated instantly. You can dive in and start yourself or let us help. The choice is yours.

Start My Free Trial

©2024 Files.com. All right reserved

FILES.COM

  • Start My Free Trial
  • Pricing
  • Docs
  • API and SDKs
  • Contact

CONTACT & SUPPORT

support@files.com

(800) 286-8372

Monday–Friday

9am–8pm Eastern