HubSpot: List Imports

← Imports operations · Get started

Operation hubspot.imports_get_imports

Provider route: GET /crm/imports/2026-09. 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["imports"]["getImports"]>[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.imports.getImports(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.imports.get_imports(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.after	string	Optional
query.limit	integer	Optional	Format: int32

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 List Imports — response body

Referenced models: List Imports — response body

Schemas

List Imports — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List Imports — response body — paging
results	array	Required within parent	An array of PublicImportResponse objects, each representing an individual import response.
results[]	Model	Each item	Expand Create Import — response body

Referenced models: List Imports — response body — paging, Create Import — response body

List Imports — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
next	Model	Optional	Expand List Imports — response body — paging next

Referenced models: List Imports — response body — paging next

Create Import — response body

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	The timestamp when the object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this import.
importName	string	Optional	The user-provided name for this import.
importRequestJson	object	Optional	The complete import request configuration as a JSON object.
importSource	string	Optional	Indicates where/how the import was initiated. Known values: API, CRM_UI, IMPORT, MOBILE_ANDROID, MOBILE_IOS, SALESFORCE
importTemplate	Model	Optional	Expand Create Import — response body — import Template
mappedObjectTypeIds	array	Required within parent	An array of object type IDs that are mapped during the import.
mappedObjectTypeIds[]	string	Each item
metadata	Model	Required within parent	Expand Create Import — response body — metadata
optOutImport	boolean	Required within parent	Whether or not the import is a list of people disqualified from receiving emails.
state	string	Required within parent	The status of the import. Known values: CANCELED, DEFERRED, DONE, FAILED, PROCESSING, REVERTED, STARTED
updatedAt	string	Required within parent	The timestamp when the import record was last updated, formatted as an ISO 8601 instant. Format: date-time

Referenced models: Create Import — response body — import Template, Create Import — response body — metadata

List Imports — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	A string token used as a cursor to fetch the next set of results in a paginated response.
link	string	Optional	A URL string that provides the link to the next page of results.

Create Import — response body — import Template

Field	Type	Presence	Description and constraints
$	object	Root
templateId	JSON	Required within parent
templateId (anyOf 1)	integer	Alternative	The unique identifier for the specific saved template or previous import being referenced. Format: int64
templateId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
templateType	string	Required within parent	The classification of what type of template this represents, and what is its origin or purpose. Known values: admin_defined, previous_import, user_file

Create Import — response body — metadata

Field	Type	Presence	Description and constraints
$	object	Root
counters	object	Required within parent	Summarized outcomes of each row a developer attempted to import into HubSpot. Additional keys: see wildcard field
counters.*	JSON	Additional keys
counters.* (anyOf 1)	integer	Alternative	Format: int32
counters.* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fileIds	array	Required within parent	The IDs of files uploaded in the File Manager API.
fileIds[]	string	Each item
objectLists	array	Required within parent	The lists containing the imported objects.
objectLists[]	Model	Each item	Expand Create Import — response body — metadata object Lists item

Referenced models: Create Import — response body — metadata object Lists item

Create Import — response body — metadata object Lists item

Field	Type	Presence	Description and constraints
$	object	Root
listId	string	Required within parent	The ID of the list containing the imported objects.
objectType	string	Required within parent	The type of object contained in the list.

Policy, approvals and errors

SDK function policy ID: hubspot.imports_get_imports. Catalog operation: imports_get_imports. 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: ["crm.import"]

Official provider source