HubSpot: Get a set of rows

← Hubdb operations · Get started

Operation hubspot.hubdb_batch_read_rows

Provider route: POST /cms/hubdb/2026-09/tables/{tableIdOrName}/rows/batch/read. 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["hubdb"]["batchReadRows"]>[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.hubdb.batchReadRows(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.hubdb.batch_read_rows(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.tableIdOrName	string	Required within parent
body	Model	Required within parent	Expand Get a set of rows — request body — body

Referenced models: Get a set of rows — request body — body

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
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Clone rows in batch — response body
$ (anyOf 2)	Model	Alternative	Expand Get a set of rows — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Clone rows in batch — response body, Get a set of rows — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING

Schemas

Get a set of rows — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of strings representing the batch input values. Each item in the array is a string.
inputs[]	string	Each item

Clone rows in batch — response body

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The timestamp indicating when the batch processing was completed. Format: date-time
links	object	Optional	A collection of related links associated with the batch response. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The timestamp indicating when the batch request was made. Format: date-time
results	array	Required within parent	An array of HubDbTableRowV3 objects representing the results of the batch operation.
results[]	Model	Each item	Expand Clone a row — response body
startedAt	string	Required within parent	The timestamp indicating when the batch processing began. Format: date-time
status	string	Required within parent	The current status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Clone a row — response body

Get a set of rows — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The timestamp indicating when the batch processing was completed. Format: date-time
errors	array	Optional	An array of StandardError objects detailing any errors encountered during the batch operation.
errors[]	Model	Each item	Expand Get a set of rows — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A collection of related links associated with the batch response. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors encountered during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The timestamp indicating when the batch request was made. Format: date-time
results	array	Required within parent	An array of HubDbTableRowV3 objects representing the successful results of the batch operation.
results[]	Model	Each item	Expand Clone a row — response body
startedAt	string	Required within parent	The timestamp indicating when the batch processing began. Format: date-time
status	string	Required within parent	The current status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Clone a row — response body, Get a set of rows — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Clone a row — response body

Field	Type	Presence	Description and constraints
$	object	Root
childTableId	string	Required within parent	Specifies the value for the column child table id
createdAt	string	Required within parent	Timestamp at which the row is created Format: date-time
id	string	Required within parent	The id of the table row
name	string	Required within parent	Specifies the value for `hs_name` column, which will be used as title in the dynamic pages
path	string	Required within parent	Specifies the value for `hs_path` column, which will be used as slug in the dynamic pages
publishedAt	string	Required within parent	The timestamp indicating when the row was last published, in date-time format. Format: date-time
updatedAt	string	Required within parent	Timestamp at which the row is updated last time Format: date-time
values	object	Required within parent	List of key value pairs with the column name and column value Additional keys: see wildcard field
values.*	object	Additional keys

Get a set of rows — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Field	Type	Presence	Description and constraints
$	object	Root	Ye olde error
category	string	Required within parent	Specifies the main category of the error, determining the broad area of issue.
context	object	Required within parent	An object containing context-specific information pertinent to the error. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	The detailed error objects.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	The unique ID of the error instance.
links	object	Required within parent	An object containing links related to the error, such as documentation URLs or support contact pages. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A detailed message describing the error.
status	string	Required within parent	The HTTP status code associated with the error.
subCategory	object	Optional	Identifies the subcategory of the error, providing more specific context within the main category.

Referenced models: Batch insert events — response body — errors item errors item

Batch insert events — response body — errors item errors item

Field	Type	Presence	Description and constraints
$	object	Root	Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response.
code	string	Optional	The status code associated with the error detail
context	object	Optional	Context about the error condition Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
in	string	Optional	The name of the field or parameter in which the error was found.
message	string	Required within parent	A human readable message describing the error along with remediation steps where appropriate
subCategory	string	Optional	A specific category that contains more specific detail about the error

Policy, approvals and errors

SDK function policy ID: hubspot.hubdb_batch_read_rows. Catalog operation: hubdb_batch_read_rows. 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: ["hubdb.rows.read"]

Official provider source