List and search folders

Lists all folders in your Filerobot store. You can search (recursively) by providing a search string.

GET /v4/folders

API permissions

OBJECTS_FETCH

Query parameters

Parameter Type Default Description
q string optional Search pattern matching the folder name or metadata.
folder string / optional Folder to start the search from. Case sensitive.
limit integer 1000 optional Specifies the maximum amount of folders to return. [1-4000].
offset integer 0 optional Specifies the offset of folders to display.
order string folder name optional Order results by: updated_at created_at Append ,asc or ,desc to get ascending or descending results. Example: updated_at,desc

Try it out

Request

Copy-paste the cURL request in your Terminal or click on the API Explorer tab to see the API in action.

host: 'https://api.filerobot.com/fdocs' path: /v4/folders method: GET parameters: folder: '/api-demo' limit: 50 offset: 0 order: 'filename,desc' variables: {} headers: X-Filerobot-Key: fa5fe3303dd34e1da4810915c7c3fd6f theme: clouds-midnight curlAPIKey: "" axiosTimeout: 35000 maxContentLength: 150000 render: curl_tab: true

Response

{
  "status": "success",
  "folders": [
    {
      "uuid": "55f9a2a6-3cfb-5430-8814-27be3f1a2962",
      "path": "/api-demo/sub",
      "name": "sub",
      "meta": {},
      "visibility": {
        "value": "VISIBILITY_INHERIT",
        "inherited": "VISIBILITY_INHERIT",
        "set": "VISIBILITY_INHERIT",
        "actual": "VISIBILITY_INHERIT"
      },
      "updated_at": "2021-05-04T10:12:39Z",
      "created_at": "2021-05-04T10:12:39Z",
      "count": {
        "files_recursive": 1,
        "files_direct": 1
      },
      "size": {
        "total_recursive_bytes": 126016,
        "total_recursive_pretty": "123.06 KB"
      },
      "public_icon": "https://scaleflex.cloudimg.io/crop/300x300/x/http://www.airstore.io/assets/dir.png"
    }
  ],
  "info": {
    "atom": "atom008",
    "response_time": 0.165
  }
}