List Folder Contents


Summary

Get a listing of files/folders for the specified path.

Endpoint

GET https://mysite.files.com/v1.2/getResourceList

Replace mysite.files.com with your site address.

Request Parameters

NameData TypeDescription
access_tokenstringRequired. The session key that identifies which user is authenticated. Either an access token returned by the authenticateUser function, or a a Files.com user API Key.
pathstringRequired. Path to list the contents of.
patternstringOnly include items whose name contains the supplied string.
offsetintegerUsed for paginating responses. Skip this number of results.
limitintegerUsed for paginating responses. Limit the total number of returned results.
sortBystringHow to sort the results.
Valid options: "sort_files_name", "sort_files_size", "sort_files_date", or "sort_files_type"
sortOrderstringWhat direction to sort the results.
Valid options "asc" or "desc"

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 by using the sortBy parameter. Valid options are "sort_files_name", "sort_files_size", "sort_files_date", or "sort_files_type". All sorting is case-insensitive.

The sort order is ascending by default. To sort in descending order, set the sortOrder parameter to "desc"

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