List Folders
Summary
Get a listing of the folders in the specified path.
Endpoint
GET https://mysite.files.com/v1.2/getFolders
Replace mysite.files.com with your site address.
Request Parameters
| Name | Data Type | Description |
|---|---|---|
access_token | string | Required. The session key that identifies which user is authenticated. Either an access token returned by the authenticateUser function, or a Files.com user API Key. |
path | string | Required. Path to list the sub-folders of. |
offset | integer | Used for paginating responses. Skip this number of results. |
limit | integer | Used for paginating responses. Limit the total number of returned results. |
sortBy | string | How to sort the results. Valid options: sort_files_name, sort_files_size, sort_files_date, or sort_files_type |
sortOrder | string | What 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 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
Specify the order of the results with 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.