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
Version id is the id of the version from the list previous versions endpoint
Required Parameters | How to use | Description |
---|---|---|
file_id | Used in the request URL | Unique identifier for a particular blog |
HubSpot OAuth Access Token or API Key | access_token=X or hapikey=X - Used in the request URL | The HubSpot API key for the portal that you're making the call for. |
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 |
file_names | string | The file name of the file you are uploading. Leave empty to use the original file name |
files | File data | The multi-part form encoded file to upload. |
folder_id | string | The id of the folder this file is in. |
folder_paths | string | The path within file manager to the folder you want to upload the files into. |
height | string | Images only, the height in pixels of the image |
id | string | The unique id of the file |
name | string | The internal name of the file |
overwrite | string | Set to 'true' if you want to overwrite a file of the same name. If false, will append a number to the file name and create a new 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 | Images only, the width in pixels of the image |