There's a new version of the HubSpot API

Check out the new API

As of November 30, 2022, HubSpot API keys are no longer a supported authentication method for accessing HubSpot APIs. Instead, you should use a private app access token or OAuth to authenticate API calls. Learn more about this change and how to migrate an API key integration to use a private app instead.

Get file metadata

Last updated May 15, 2023

GET /filemanager/api/v2/files/:file_id

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

files

Get the metadata for a specific file, by ID.

Required Parameters How to use Description
OAuth access token or private app access token Authorization: Bearer {token} header Used to authenticate the request. Please see this page for more details about authentication.
file_id Used in the request URL Unique identifier for a particular file

Hit this URL with a HTTP method of GET  http://api.hubapi.com/filemanager/api/v2/files/358134645

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 This file property is deprecated; it will automatically be set to be equal to the ‘name’ property.
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

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example GET URL: https://api.hubapi.com/filemanager/api/v2/files/5323360053 Example response: { "id": 5323360053, "portal_id": 62515, "name": "ScrollMagic", "size": 35938, "height": null, "width": null, "encoding": null, "type": "OTHER", "extension": "js", "cloud_key": "hubfs/62515/plugins/scrollmagic/uncompressed/ScrollMagic.js", "s3_url": "http://cdn1.hubspot.com/hubfs/62515/plugins/scrollmagic/uncompressed/ScrollMagic.js", "friendly_url": "https://cdn2.hubspot.net/hubfs/62515/plugins/scrollmagic/uncompressed/ScrollMagic.js", "alt_key": "hubfs/62515/plugins/scrollmagic/uncompressed/scrollmagic", "alt_key_hash": "1769708800fd59e887ec299715cd6118", "title": "ScrollMagic", "meta": { "url_scheme": "SIMPLIFIED", "allows_anonymous_access": true }, "created": 1504354553352, "updated": 1504354553453, "deleted_at": 0, "folder_id": 5323360027, "hidden": false, "cloud_key_hash": "8bd641bca694eef1e2c47dc8eefc3ea3", "archived": false, "created_by": null, "deleted_by": null, "replaceable": true, "url": "https://cdn2.hubspot.net/hubfs/62515/plugins/scrollmagic/uncompressed/ScrollMagic.js", "alt_url": "http://cdn2.hubspot.net/hubfs/62515/plugins/scrollmagic/uncompressed/scrollmagic.js", "cdn_purge_embargo_time": null, "file_hash": null }