HubSpot: Get the metadata for a file

← Source code operations · Get started

Operation hubspot.source_code_get_file_metadata

Provider route: GET /cms/source-code/2026-09/{environment}/metadata/{path}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["sourceCode"]["getFileMetadata"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.sourceCode.getFileMetadata(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.source_code.get_file_metadata(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.environment	string	Required within parent
path.path	string	Required within parent	Pattern: .+
query	object	Optional	Additional keys: not allowed
query.properties	string	Optional

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Create a file — response body

Referenced models: Create a file — response body

Schemas

Create a file — response body

Field	Type	Presence	Description and constraints
$	object	Root
archivedAt	JSON	Optional
archivedAt (anyOf 1)	integer	Alternative	Timestamp of when the object was archived (deleted). Format: int64
archivedAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
children	array	Optional	If the object is a folder, contains the filenames of the files within the folder.
children[]	string	Each item
createdAt	JSON	Required within parent
createdAt (anyOf 1)	integer	Alternative	Timestamp of when the object was first created. Format: int64
createdAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
folder	boolean	Required within parent	Determines whether or not this path points to a folder.
hash	string	Optional	A unique identifier for the file's content, used to verify data integrity.
id	string	Required within parent	The path of the file in the CMS Developer File System.
name	string	Required within parent	The name of the file.
updatedAt	JSON	Required within parent
updatedAt (anyOf 1)	integer	Alternative	Timestamp of when the object was last updated. Format: int64
updatedAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: hubspot.source_code_get_file_metadata. Catalog operation: source_code_get_file_metadata. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["content"]

Official provider source