a1bd874b5960
Get a list of all resources
Returns a list of files and folders in the account. Use the resource query parameter to indicate the folder you wish to search in (which can be /).
Searching for Files and Folders
Using the name parameter triggers search mode, which will search the entire directory structure under the provided resource for files or folders with names matching the provided name. This supports wildcard matching such as:
- *Report* would find any files or folders with "Report" in the name.
- Data_202?-09-30.xlsx would match items such as "Data_2020-09-30.xlsx", "DATA_2021-09-30.xlsx", "data_2022-09-30.xlsx" etc.
- sales* would find any files or folders starting with the word "Sales"
- *.csv would locate any files ending in ".csv"
- * matches everything within the directory tree starting at your given resource
The search is not case-sensitive. Searching for Clients* or clients* or CLIENTS*, etc. will provide identical results
If you are using the name parameter to run a search, the type parameter will be ignored by the server.
Query parameters
Resource identifier to get resources for. Can be path/id/name.
Endpoint support multiple sort fields by allowing array of sort params. Sort fields should be applied in the order specified. The sort order for each sort field is ascending unless it is prefixed with a minus (“-“), in which case it will be descending.
Determines which item to start on for pagination. Use zero (0) to start at the beginning of the list. e.g, setting offset=200 would trigger the server to skip the first 200 matching entries when returning the results.
The number of files to limit the result. If you have more files in your directory than this limit, make multiple calls, incrementing the offset parameter, above.
Limit types of resources returned to "file" or "dir" only. This is ignored if you are using the name parameter to trigger a search.
Text to match resource names. This allows you to filter the results returned. For example, to locate only zip archive files, you can enter *zip and only resources ending in "zip" will be included in the list of results.
Comma separated list of relationships to include in response. Possible values are share, notifications, directFile, parentResource, ownerUser, ownerAccount.
Headers
API Key required to make the API call.
Access token required to make the API call.
Response
Successful Operation