List Folder Contents
Summary
List the contents of a folder.
Endpoint
GET https://mysite.files.com/api/v2/resources/list
Replace mysite.files.com with your site address.
Request Parameters
| Name | Data Type | Description |
|---|---|---|
resource | string | Required. The folder to locate resources within. It can be specified as either the complete path (e.g. my/folder) or as a resource ID (e.g. id:31415926535) |
type | string | Used for filtering results to include only files or only folders. Possible values: file or dir |
name | string | Used for filtering results whose name includes the given text. Supports wildcards within the string (e.g sa*.txt for items starting with "sa" and ending with ".txt"), but not at the start of the string, such as *.pdf. |
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 | Which field to use for sorting the users list. Valid options are name, size, or date. |
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 name, size or date. All sorting is case-insensitive.
The sort order is ascending by default. To sort in descending order, prefix the sort value with - (a minus/hyphen character), for example: -date.