List file(s)

Lists files in your Filerobot store.

GET /v4/files
GET /v4/list

The /v4/files API roughly matches the Unix ls command. If you want to list files across folders, then use the /v4/search API that imitates the Unix find command

API permissions

OBJECTS_LIST

Query parameters

Parameter Type Default Description
folder string [Optional] / Specifies folder from which to list files. Case sensitive.
Example: /path/to/folder
limit number [Optional] 1000 Specifies the maximum amount of files and folders to return [1 - 4000]
offset number [Optional] 0 Specifies the offset of files and folders to display
mime mimeType [Optional] None Returns only files from specified mimeType
search string [Optional] None Returns files and directories with filename, tags or description matching the search string

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/fusqadtm' path: /v4/files method: GET parameters: folder: '/' limit: 50 offset: 0 order: 'filename,desc' variables: {} headers: X-Filerobot-Key: 19692813e7364ef8ad6a6504d50a12ca theme: clouds-midnight curlAPIKey: "" axiosTimeout: 35000 maxContentLength: 150000 render: curl_tab: true

Response

{
    "status": "success",
    "files": [
        {
            "uuid": "50072e82-98b7-5ad4-9bfe-4afe1b450000",
            "name": "alps.jpg",
            "size": {
                "bytes": 10,
                "pretty": "10 B"
            },
            "flags": null,
            "type": "text/plain",
            "info": {},
            "meta": {},
            "visibility": {
                "value": "VISIBILITY_INHERIT",
                "inherited": "VISIBILITY_PUBLIC",
                "set": "VISIBILITY_INHERIT",
                "actual": "VISIBILITY_PUBLIC"
            },
            "url": {
                "public": "https://store.filerobot.com/fusqadtm/alps.jpg",
                "permalink": "https://api.filerobot.com/fusqadtm/v2/get/50072e82-98b7-5ad4-9bfe-4afe1b450000",
                "cdn": "https://fusqadtm.filerobot.com/alps.jpg?vh=4dad61&func=proxy",
                "path": "/alps.jpg"
            },
            "hash": {
                "sha1": "4dad61256b77e7bf35455f506722ad5ce72f87d4",
                "blurhash": null
            },
            "created_at": "2020-07-28T09:00:28Z",
            "modified_at": "2020-07-28T09:00:29Z",
            "folder": {
                "uuid": "7e766397-b258-53b1-933a-a338503e7ebe",
                "name": "/"
            },
            "product": {
                "ref": null,
                "position": null
            }
        },
        {
            "uuid": "915a6ba8-32a0-5a8d-b39f-f58bc6250000",
            "name": "Bananas.svg",
            "size": {
                "bytes": 13228,
                "pretty": "12.92 KB"
            },
            "flags": null,
            "type": "image/svg+xml",
            "info": {},
            "meta": {},
            "visibility": {
                "value": "VISIBILITY_INHERIT",
                "inherited": "VISIBILITY_PUBLIC",
                "set": "VISIBILITY_INHERIT",
                "actual": "VISIBILITY_PUBLIC"
            },
            "url": {
                "public": "https://store.filerobot.com/fusqadtm/Bananas.svg",
                "permalink": "https://api.filerobot.com/fusqadtm/v2/get/915a6ba8-32a0-5a8d-b39f-f58bc6250000",
                "cdn": "https://fusqadtm.filerobot.com/Bananas.svg",
                "path": "/Bananas.svg"
            },
            "hash": {
                "sha1": null,
                "blurhash": null
            },
            "created_at": "2019-09-30T15:51:55Z",
            "modified_at": "2019-09-30T15:52:05Z",
            "folder": {
                "uuid": "7e766397-b258-53b1-933a-a338503e7ebe",
                "name": "/"
            },
            "product": {
                "ref": null,
                "position": null
            }
        },
        {
            "uuid": "bb1ce06f-2677-581a-85e7-28c00ec50000",
            "name": "boat.jpg",
            "size": {
                "bytes": 551378,
                "pretty": "538.46 KB"
            },
            "flags": null,
            "type": "image/jpeg",
            "info": {},
            "meta": {},
            "visibility": {
                "value": "VISIBILITY_INHERIT",
                "inherited": "VISIBILITY_PUBLIC",
                "set": "VISIBILITY_INHERIT",
                "actual": "VISIBILITY_PUBLIC"
            },
            "url": {
                "public": "https://store.filerobot.com/fusqadtm/boat.jpg",
                "permalink": "https://api.filerobot.com/fusqadtm/v2/get/bb1ce06f-2677-581a-85e7-28c00ec50000",
                "cdn": "https://fusqadtm.filerobot.com/boat.jpg",
                "path": "/boat.jpg"
            },
            "hash": {
                "sha1": null,
                "blurhash": null
            },
            "created_at": "2019-11-22T10:52:00Z",
            "modified_at": "2020-03-17T19:27:17Z",
            "folder": {
                "uuid": "7e766397-b258-53b1-933a-a338503e7ebe",
                "name": "/"
            },
            "product": {
                "ref": null,
                "position": null
            }
        }
    ],
    "info": {
        "total_files_count": 3,
        "total_files_method": "COUNT_EXACT",
        "atom": "atom008",
        "response_time_s": 0.088
    }
}