Sign in

v1

latestOpenAPI 3.0.12026-07-14182037.3 KB
Files

Get file.

Get file by ID.

get/files/v3/files/{fileId}

Path parameters

fileIdstring required

Id of the desired file.

Query parameters

propertiesstring[]

Response

successful operation

access'PUBLIC_INDEXABLE' | 'PUBLIC_NOT_INDEXABLE' | 'HIDDEN_INDEXABLE' | 'HIDDEN_NOT_INDEXABLE' | 'HIDDEN_PRIVATE' | 'PRIVATE' required

File access. Can be PUBLIC_INDEXABLE, PUBLIC_NOT_INDEXABLE, PRIVATE.

archivedboolean required

If the file is deleted.

archivedAtstring date-time

Deletion time of the file object.

createdAtstring date-time required

Creation time of the file object.

defaultHostingUrlstring

Default hosting URL of the file. This will use one of HubSpot's provided URLs to serve the file.

encodingstring

Encoding of the file.

extensionstring

Extension of the file. For example png.

heightinteger

For image and video files, the height of the content.

idstring required

File ID.

isUsableInContentboolean

Previously "archied". Indicates if the file should be used when creating new content like web pages.

namestring

Name of the file.

parentFolderIdstring

Id of the folder the file is in.

pathstring

Path of the file in the file manager.

sizeinteger

Size in bytes of the file.

typestring

Type of the file. Can be IMG, DOCUMENT, AUDIO, MOVIE, or OTHER.

updatedAtstring date-time required

Timestamp of the latest update to the file.

urlstring

URL of the given file. This URL can change depending on the domain settings of the account. Will use the select file hosting domain.

widthinteger

For image and video files, the width of the content.