HubSpot: Retrieve folder
HubSpot files.getFoldersByFolderId: arguments, response, policy and SDK examples.
← Files operations · Get started
Operation hubspot.files_get_folders_by_folder_id
Provider route: GET /files/2026-09/folders/{folderId}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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["files"]["getFoldersByFolderId"]>[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.files.getFoldersByFolderId(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.files.get_folders_by_folder_id(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.folderId | string | Required within parent | Pattern: \d+ |
query | object | Optional | Additional keys: not allowed |
query.properties | array | Optional | |
query.properties[] | string | Each item |
Response
Section titled “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 folder — response body |
Referenced models: Create folder — response body
Schemas
Section titled “Schemas”Create folder — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
archived | boolean | Required within parent | A boolean indicating whether the folder is archived. |
archivedAt | string | Optional | The date and time when the folder was archived, in ISO 8601 format. Format: date-time |
createdAt | string | Required within parent | The date and time when the folder was created, in ISO 8601 format. Format: date-time |
id | string | Required within parent | The unique ID for the folder, represented as a string. |
name | string | Optional | The name of the folder, represented as a string. |
parentFolderId | string | Optional | The unique identifier of the parent folder, represented as a string. |
path | string | Optional | The path of the folder within the file system, represented as a string. |
updatedAt | string | Required within parent | The date and time when the folder was last updated, in ISO 8601 format. Format: date-time |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: hubspot.files_get_folders_by_folder_id. Catalog operation: files_get_folders_by_folder_id. 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: ["files.ui_hidden.read"]