List the metadata for all files

GET /filemanager/api/v2/files

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Get the details for all files stored in file manager. Supports filter, see below for options.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.

Optional query string filters & options

If a parameter supports a filter type of 'gt', that means you can append a double underscore to the parameter name to find all items greater than the value. For example, the following query will find all items created than the 'updated' time:
Parameter name Description
limit The number of items to return. Defaults to 20.
offset The offset set to start returning rows from. Defaults to 0.
alt_key Specify a file alt_key.
archived Get only archived or not archived files. This paramater is a boolean so it takes either a true or false value.
created Get files created on or after a certain date. Available filers are exact, range, gt, gte, lt, lte. Use the parameter followed by two underscores and the filter of choice. For example created__gt=1431489600000 will return all files created after May 15, 2015. Filters take unix timestamps in milliseconds.
deleted_at Get files deleted on or after a certain date. Available filters are exact, range, gt, gte, lt, lte. Use the parameter followed by two underscores and the filter of choice. For example deleted_at__lt=1431489600000 will return all files deleted before May 15, 2015. Filters take unix timestamps in milliseconds.
extension Get all files with a certain extension. e.g. extension=pdf returns all .pdf files.
folder_id Get all files in a certain folder. By default all files are returned.
id Specify a file.
name Get files with a certain naming convention. Available filters are exact, contains, icontains. Use the paramter followed by two underscores and the filter of choice. For example name__icontains=abc will return all files that have the characters abc (in a row) in the filename.
type Get files of a certain type. Available filters are exact and ne. Use the paramter followed by two underscores and the filter of choice. For example type__ne=IMG will return all files that are not images.

Hit this URL with a HTTP method of GET http://api.hubapi.com/filemanager/api/v2/files?hapikey=demo

JSON Fields returned in the response

Parameter name Type Description
alt_key string An alternative file key. This is used for creationg the 'alt_url', which is a url for the file that does not include the file id. This is useful if you need to upload a collection of files where their relative location needs to preserved
alt_url string The alternative file URL, without the auto-generated file id in it. This is generated by concatenating the alt_key to the base CDN url
archived bool If True, the file will not show up in your dashboard, although the file will still be live
created long When the file was first created, in milliseconds since the epoch
deleted_at long When the file was deleted, in milliseconds since the epoch. Zero if the file was never deleted. Use a DELETE request to file the page, do not set this directly.
extension string The extension of the file
folder_id string The id of the folder this file is in.
height string For images, the height in pixels of the image
id string The unique id of the file
name string The internal name of the file
size string The size in bytes of the file
title string The title of the file
type string A string enum for type of the file: IMG, TEXT, DOCUMENT, or OTHER
updated long When the file was last updated, in milliseconds since the epoch
url string The URL to access the file
width string For images, the width in pixels of the image