Skip to content

HubSpot: Retrieve data source

HubSpot dataSources.getDatasource: arguments, response, policy and SDK examples.

← Data sources operations · Get started

Operation hubspot.data_sources_get_datasource

Provider route: GET /data-studio/data-source/2026-09/{datasourceId}. Alter supplies the connection’s credentials and routing.

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["dataSources"]["getDatasource"]>[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.dataSources.getDatasource(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.data_sources.get_datasource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.datasourceIdintegerRequired within parentFormat: int64

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve data source — response body

Referenced models: Retrieve data source — response body

Retrieve data source — response body
FieldTypePresenceDescription and constraints
$objectRoot
columnsarrayRequired within parentAn array of FileColumn objects representing the columns in the data source.
columns[]ModelEach itemExpand Retrieve data source — response body — columns item
createdAtstringRequired within parentThe creation date and time of the data source, represented as a string.
datasourceIdstringRequired within parentThe unique identifier for the data source, represented as a 64-bit integer.
datasourceNamestringRequired within parentThe name of the data source, represented as a string.
datasourceTypestringRequired within parentThe type of the data source, which is a string with a valid value of 'FILE'.
Known values: FILE, JSON
lastIngestionStatusstringRequired within parentThe status of the last data ingestion process, represented as a string. Valid values include 'SUCCESSFUL', 'IN_PROGRESS', and 'FAILED'.
Known values: FAILED, IN_PROGRESS, SUCCESSFUL

Referenced models: Retrieve data source — response body — columns item

Retrieve data source — response body — columns item
FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentThe name of the column, represented as a string.
typestringRequired within parentThe data type of the column, represented as a string.

SDK function policy ID: hubspot.data_sources_get_datasource. Catalog operation: data_sources_get_datasource. 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: ["data_integration.data_source.file.read"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.