Basic

Get the metadata for a file

Changed on

Gets the metadata object for the file at the specified path in the specified environment.

get/cms/source-code/2026-09/{environment}/metadata/{path}

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/cms/source-code/2026-09/{environment}/metadata/{path}
  • Auth
    OAuth 2
    Authorization code: https://app.hubspot.com/oauth/authorize
    Token URL: https://api.hubapi.com/oauth/v1/token scopes: content

Path parameters

environmentstring required

The environment in which the file or folder is located, such as 'staging' or 'production'.

pathstring required

The path to the specific file or folder for which metadata is being retrieved.

Query parameters

propertiesstring

A comma-separated list of specific properties to include in the response.

Response

successful operation

archivedAtinteger

Timestamp of when the object was archived (deleted).

childrenstring[]

If the object is a folder, contains the filenames of the files within the folder.

createdAtinteger required

Timestamp of when the object was first created.

folderboolean required

Determines whether or not this path points to a folder.

hashstring

A unique identifier for the file's content, used to verify data integrity.

idstring required

The path of the file in the CMS Developer File System.

namestring required

The name of the file.

updatedAtinteger required

Timestamp of when the object was last updated.

Changes