List and search files

Lists all files in your Filerobot store. You can search by providing a search string. Can be recursive.

/v4/files

API permissions

OBJECTS_LIST

Query parameters

Parameter	Type	Default	Description
`q`	string		optional Search pattern matching the file name or metadata.
`folder`	string	/	optional Folder to start the search from. Case sensitive.
`limit`	integer	1000	optional Specifies the maximum amount of files to return. [1-4000].
`offset`	integer	0	optional Specifies the offset of files to display.
`mime`	mimeType	None	optional Returns only files from specified mimeType.
`order`\|`sort`	string	filename:asc	optional Specifies how the results should be ordered / sorted (see Order values below). Example: updated_at:desc
`format`	string		optional Sets the format of the response to csv or json (default) and defines the display format for different field types (see Format parameter section below). Example: format=json,select:api
`created_after` \| `created_before` \| `updated_after` \| `updated_before`	string \| date \| timestamp		optional Filters the results by creation and/or update time and date (see Filter parameters section below). Example: created_after=2021-07-20&created_before=3+days+ago
`variant`	string		optional Defines the variant for the localized metadata fields (language, currency, etc.) If not set, all variants are returned. Example: variant:en,EUR

Order values

Key	Value	Default	Description
`filename`	`asc`\|`desc`	filename:asc	optional Sorts the results by filename.
`created_at`	`asc`\|`desc`	-	optional Sorts the results by creation date.
`updated_at`	`asc`\|`desc`	-	optional Sorts the results by last update.

Format parameter

Key	Value	Default	Description
`csv`\|`json`	-	json	optional Sets the response format to either csv or json (default). Example: format=csv
`select`	`api`\|`label`\|`internal`	select:internal	optional Formats the select and multi-select field values in the response. Useful for returning values as human-readable labels instead of internal keys. Example: format=select:label
`tags`	`json_full` \| `json_compact`	tags:json_full	optional Sets the tag display format. `json_full` will return tag values and internal keys while `json_compact` will only return the values. Example: format=tags:json_compact

Examples
`format=json,select:internal`
`format=csv,select:label,tags:json_compact`

Filter parameters

Results can be filtered by create and/or update date and time. To limit the results by date and time, you can combine the following parameters: created_before=time_format, created_after=time_format, updated_before=time_format, updated_after=time_format.

Time format	Format	Example
date	`YYYY-MM-DD`	2021-01-21
timestamp	`YYYY-MM-DDTHH:mm:ss`	2021-01-21T17:32:00
string		1 week ago, 4 days ago, 2 months ago

Examples
`created_before=4+months+ago&updated_before=1+week+ago`
`created_before=2021-01-21T17:32:00&created_after=2020-10-01`

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/files 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",
  "base": {
    "uuid": "c35f5199-19da-57e1-9230-ec4a136db6b6",
    "path": "/api-demo/new-folder",
    "name": "new-folder",
    "meta": {},
    "visibility": "VISIBILITY_INHERIT",
    "updated_at": "2021-08-10T17:36:19Z",
    "created_at": "2021-08-10T17:36:19Z",
    "count": {
      "files_recursive": 1,
      "files_direct": 1
    },
    "size": {
      "total_recursive_bytes": 159251,
      "total_recursive_pretty": "155.52 KB"
    },
    "public_icon": "https://scaleflex.cloudimg.io/crop/300x300/x/http://www.airstore.io/assets/dir.png"
  },
  "files": [
    {
      "uuid": "5cef5078-103b-50cb-9b7e-fbb5e5150000",
      "name": "model.jpg",
      "extension": "jpg",
      "size": {
        "bytes": 159251,
        "pretty": "155.52 KB"
      },
      "type": "image/jpeg",
      "info": {
        "name": "model.jpg",
        "type": "image/jpeg",
        "img_h": 1000,
        "img_w": 667,
        "img_type": "JPEG"
      },
      "meta": {
        "title": {
          "de_DE": "Hut",
          "en_US": "hat",
          "fr_FR": "chapeau",
          "it_IT": "cappello"
        },
        "description": {
          "de_DE": "M\u00e4dchen mit Hut",
          "en_US": "A girl with a hat",
          "fr_FR": "Fille avec un chapeau",
          "it_IT": "Ragazza con cappello"
        },
        "category": [
          "@itm_v1_1eff5362_3@"
        ],
        "price": "75",
        "sku": "700300",
        "color": [
          "@itm_v1_19e7db79_5@"
        ],
        "material": "wool"
      },
      "tags": {},
      "visibility": {
        "value": "VISIBILITY_INHERIT",
        "inherited": "VISIBILITY_PUBLIC",
        "set": "VISIBILITY_INHERIT",
        "actual": "VISIBILITY_PUBLIC"
      },
      "url": {
        "public": "https://store.filerobot.com/fdocs/api-demo/new-folder/model.jpg",
        "permalink": "https://api.filerobot.com/fdocs/v4/get/5cef5078-103b-50cb-9b7e-fbb5e5150000",
        "cdn": "https://fdocs.filerobot.com/api-demo/new-folder/model.jpg?vh=78d01b",
        "path": "/api-demo/new-folder/model.jpg"
      },
      "hash": {
        "sha1": "78d01bf1ea2fc50f08b5ae227dfa34ed4f8de613",
        "blurhash": "AcE.;M-p?woz"
      },
      "created_at": "2021-08-23T12:42:45Z",
      "modified_at": "2021-08-23T12:53:21Z",
      "folder": {
        "uuid": "c35f5199-19da-57e1-9230-ec4a136db6b6",
        "name": "/api-demo/new-folder"
      },
      "product": {
        "ref": null,
        "position": null
      }
    }
  ],
  "folders": [],
  "info": {
    "total_files_count": 1,
    "total_files_size": 159251.0,
    "total_files_method": "COUNT_EXACT",
    "atom": "atom014",
    "response_time_s": 0.043
  }
}

File API

Get file details

Was this page helpful?