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.
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["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 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.data_sources.get_datasource(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.datasourceId | integer | Required within parent | Format: int64 |
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 Retrieve data source — response body |
Referenced models: Retrieve data source — response body
Schemas
Section titled “Schemas”Retrieve data source — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
columns | array | Required within parent | An array of FileColumn objects representing the columns in the data source. |
columns[] | Model | Each item | Expand Retrieve data source — response body — columns item |
createdAt | string | Required within parent | The creation date and time of the data source, represented as a string. |
datasourceId | string | Required within parent | The unique identifier for the data source, represented as a 64-bit integer. |
datasourceName | string | Required within parent | The name of the data source, represented as a string. |
datasourceType | string | Required within parent | The type of the data source, which is a string with a valid value of 'FILE'. Known values: FILE, JSON |
lastIngestionStatus | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Required within parent | The name of the column, represented as a string. |
type | string | Required within parent | The data type of the column, represented as a string. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]