Method Details
HTTP Methods:
GET
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing & CRM
Required Scope:
Get the metadata for a specific file, by ID.
There's a new version of the HubSpot API
We're also working on a new documentation website, you're invited to check it out and give us your feedback.
HTTP Methods:
GET
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing & CRM
Required Scope:
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
| 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 |