List & search folders
GET {{api-server}}/:token/{{api-version}}/folders
This API is used to list and search folders.
Query string parameters:
| Name: | Description: | Syntax: | Value/Example: |
|---|---|---|---|
q= | Performs a Fuzzy search for folder names in the folder tree of the project. The fuzzy search is able to return partial matches of the searched keyword | In case of any special character in the folder's name, it should be encoded. | &q=february 2024 |
folder= | Defines the starting point of the search request | Default value - / (the Root folder /) | &folder=/ |
recursive= | Specifies whether the system should search the current folder and all subfolders or only the current folder. It can be 0 or 1. | With the default value of 0, it will only search the current folder. The content of the subfolders is included in the search scope when recursive=1. | &recursive=1 |
offset= | Start offset (used for pagination) | &offset=0 | |
limit= | Limits the number of returned results (used for pagination) | limit=1000 |
Sorting search results
The results can be sorted in ascending asc and descending desc order.
| Name: | Description: | Syntax: | Value/Example: |
|---|---|---|---|
name | Sorting by folder name | &sort=name:desc | |
created_at | Sorting by the date when the folder has been created. | &sort=created_at:desc | |
modified_at | Sorting by the date when the folder's properties have been edited for the last time. In case an asset has been added, moved or deleted from a folder, that counts as a modificationtoo. | &sort=modified_at:desc | |
assets_count | Sorting by the total number of assets in the folder | &sort=assets_count:desc | |
size | Sorting by the folder's size in bytes | &sort=size:asc |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
q | string | Search string. If missing, endpoint behaves as a list endpoint | |
folder | string | Base list/search folder,ie. where to search | |
recursive | number | Whether to list/search recursively. | |
limit | number | Result limit (for pagination). | |
offset | number | Start offset (for pagination). | |
order | string | See "order search results" In "List and search folders" for more info. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Filerobot-Key | string | Filerobot API key | |
Content-Type | string |
RESPONSES
status: OK
{"status":"success","base":{"uuid":"7610923e-80d0-50e8-a2e4-c509be390158","path":"/api-demo","name":"api-demo","meta":{},"visibility":{"value":"VISIBILITY_INHERIT","inherited":"VISIBILITY_ORGANISATION","set":"VISIBILITY_INHERIT","actual":"VISIBILITY_ORGANISATION"},"visibilities":{"value":"VISIBILITY_INHERIT","inherited":"VISIBILITY_ORGANISATION","set":"VISIBILITY_INHERIT","actual":"VISIBILITY_ORGANISATION"},"updated_at":"2021-05-04T09:00:53Z","created_at":"2021-05-04T09:00:53Z","count":{"files_recursive":72,"files_direct":79},"size":{"total_recursive_bytes":180384569,"total_recursive_pretty":"172.03 MB"},"public_icon":"https://scaleflex.cloudimg.io/crop/300x300/x/http://www.airstore.io/assets/dir.png"},"folders":[{"uuid":"0c37f602-7663-5375-8542-7b627ec16e31","path":"/api-demo/new-folder","name":"new-folder","meta":"{}","visibility":{"value":"VISIBILITY_INHERIT","inherited":"VISIBILITY_ORGANISATION","set":"VISIBILITY_INHERIT","actual":"VISIBILITY_ORGANISATION"},"visibilities":{"value":"VISIBILITY_INHERIT","inherited":"VISIBILITY_ORGANISATION","set":"VISIBILITY_INHERIT","actual":"VISIBILITY_ORGANISATION"},"updated_at":"2022-08-08T12:38:51Z","created_at":"2022-08-08T12:38:51Z","count":{"files_recursive":0,"files_direct":0},"size":{"total_recursive_bytes":0,"total_recursive_pretty":"0 B"},"public_icon":"https://scaleflex.cloudimg.io/crop/300x300/x/http://www.airstore.io/assets/dir.png"},{"uuid":"c35f5199-19da-57e1-9230-ec4a136db6b6","path":"/api-demo/new-name","name":"new-name","meta":"{}","visibility":{"value":"VISIBILITY_INHERIT","inherited":"VISIBILITY_ORGANISATION","set":"VISIBILITY_INHERIT","actual":"VISIBILITY_ORGANISATION"},"visibilities":{"value":"VISIBILITY_INHERIT","inherited":"VISIBILITY_ORGANISATION","set":"VISIBILITY_INHERIT","actual":"VISIBILITY_ORGANISATION"},"updated_at":"2022-07-08T07:17:37Z","created_at":"2021-08-10T17:36:19Z","count":{"files_recursive":2,"files_direct":2},"size":{"total_recursive_bytes":326273,"total_recursive_pretty":"318.63 KB"},"public_icon":"https://scaleflex.cloudimg.io/crop/300x300/x/http://www.airstore.io/assets/dir.png"},{"uuid":"de2a0a98-215b-5d19-8f9f-6378e4db7af1","path":"/api-demo/new-name/folder-change","name":"folder-change","meta":"{}","visibility":{"value":"VISIBILITY_INHERIT","inherited":"VISIBILITY_ORGANISATION","set":"VISIBILITY_INHERIT","actual":"VISIBILITY_ORGANISATION"},"visibilities":{"value":"VISIBILITY_INHERIT","inherited":"VISIBILITY_ORGANISATION","set":"VISIBILITY_INHERIT","actual":"VISIBILITY_ORGANISATION"},"updated_at":"2022-07-08T07:17:37Z","created_at":"2021-09-22T13:55:18Z","count":{"files_recursive":0,"files_direct":0},"size":{"total_recursive_bytes":0,"total_recursive_pretty":"0 B"},"public_icon":"https://scaleflex.cloudimg.io/crop/300x300/x/http://www.airstore.io/assets/dir.png"},{"uuid":"427937a1-f141-53bc-92c4-e6a0956e61c9","path":"/api-demo/test","name":"test","meta":"{}","visibility":{"value":"VISIBILITY_INHERIT","inherited":"VISIBILITY_ORGANISATION","set":"VISIBILITY_INHERIT","actual":"VISIBILITY_ORGANISATION"},"visibilities":{"value":"VISIBILITY_INHERIT","inherited":"VISIBILITY_ORGANISATION","set":"VISIBILITY_INHERIT","actual":"VISIBILITY_ORGANISATION"},"updated_at":"2023-07-26T04:50:12Z","created_at":"2023-07-26T04:50:12Z","count":{"files_recursive":0,"files_direct":0},"size":{"total_recursive_bytes":0,"total_recursive_pretty":"0 B"},"public_icon":"https://scaleflex.cloudimg.io/crop/300x300/x/http://www.airstore.io/assets/dir.png"},{"uuid":"95ab2184-cdbb-5db4-af9d-bbd518f39ae4","path":"/api-demo/test-folder","name":"test-folder","meta":"{}","visibility":{"value":"VISIBILITY_INHERIT","inherited":"VISIBILITY_ORGANISATION","set":"VISIBILITY_INHERIT","actual":"VISIBILITY_ORGANISATION"},"visibilities":{"value":"VISIBILITY_INHERIT","inherited":"VISIBILITY_ORGANISATION","set":"VISIBILITY_INHERIT","actual":"VISIBILITY_ORGANISATION"},"updated_at":"2022-04-11T12:40:13Z","created_at":"2022-04-11T12:40:13Z","count":{"files_recursive":0,"files_direct":0},"size":{"total_recursive_bytes":0,"total_recursive_pretty":"0 B"},"public_icon":"https://scaleflex.cloudimg.io/crop/300x300/x/http://www.airstore.io/assets/dir.png"}],"warnings":[],"stats":{"approx_folders_count":5,"approx_folders_count_method":"COUNT_EXACT"},"info":{"atom":"atom014","response_time":{"db_conn":913,"db_query":353,"db_query_core":5,"parse":0}},"api_version":{"hash":"ed8718a742085aed68a46b4a95c50ac0a1d0d1ae","datetime":"2023-07-18T11:26:26+07:00"}}