GET
/
files
/
v3
/
files
/
stat
/
{path}
Retrieve file by path
curl --request GET \
  --url https://api.hubapi.com/files/v3/files/stat/{path} \
  --header 'Authorization: Bearer <token>'
{
  "file": {
    "extension": "<string>",
    "access": "PUBLIC_INDEXABLE",
    "parentFolderId": "<string>",
    "sourceGroup": "<string>",
    "fileMd5": "<string>",
    "encoding": "<string>",
    "type": "<string>",
    "isUsableInContent": true,
    "url": "<string>",
    "expiresAt": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "archivedAt": "2023-11-07T05:31:56Z",
    "path": "<string>",
    "archived": true,
    "size": 123,
    "name": "<string>",
    "width": 123,
    "id": "<string>",
    "defaultHostingUrl": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "height": 123
  },
  "folder": {
    "createdAt": "2023-11-07T05:31:56Z",
    "archivedAt": "2023-11-07T05:31:56Z",
    "path": "<string>",
    "archived": true,
    "parentFolderId": "<string>",
    "name": "<string>",
    "id": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
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

​
path
string
required

The path of the file.

Query Parameters

​
properties
string[]

Properties to return in the response.

Response

200
application/json

successful operation

The response is of type object.