GET
/
files
/
v3
/
files
/
{fileId}
/
signed-url
Get signed URL to access private file
curl --request GET \
  --url https://api.hubapi.com/files/v3/files/{fileId}/signed-url \
  --header 'Authorization: Bearer <token>'
{
  "extension": "<string>",
  "size": 123,
  "name": "<string>",
  "width": 123,
  "type": "<string>",
  "url": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "height": 123
}
Supported products
Requires one of the following products or higher.
Marketing HubMarketing HubFree
Sales HubSales HubFree
Service HubService HubFree
Content HubContent HubStarter

Required Scopes

This API requires one of the following scopes:
  • files.ui_hidden.read
  • files

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

fileId
string
required

ID of file.

Query Parameters

size
enum<string>

For image files. This will resize the image to the desired size before sharing. Does not affect the original file, just the file served by this signed URL.

Available options:
thumb,
icon,
medium,
preview
expirationSeconds
integer

How long in seconds the link will provide access to the file.

upscale
boolean

If size is provided, this will upscale the image to fit the size dimensions.

Response

200
application/json

successful operation

Signed Url object with optional ancillary metadata of requested file