HubSpot: Get rows for a table

← Hubdb operations · Get started

Operation hubspot.hubdb_get_rows

Provider route: GET /cms/hubdb/2026-09/tables/{tableIdOrName}/rows. 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"]["getRows"]>[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.getRows(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.get_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
query	object	Optional	Additional keys: not allowed
query.after	string	Optional
query.archived	boolean	Optional
query.limit	integer	Optional	Format: int32
query.offset	integer	Optional	Format: int32
query.properties	array	Optional
query.properties[]	string	Each item
query.sort	array	Optional
query.sort[]	string	Each item

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 Get rows for a table — response body

Referenced models: Get rows for a table — response body

Schemas

Get rows for a table — response body

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Get rows for a table — response body — type: RANDOM ACCESS
$ (anyOf 2)	Model	Alternative	Expand Get rows for a table — response body — type: STREAMING

Referenced models: Get rows for a table — response body — type: RANDOM ACCESS, Get rows for a table — response body — type: STREAMING

Get rows for a table — response body — type: RANDOM ACCESS

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Get rows for a table — response body — type: RANDOM ACCESS paging
results	array	Required within parent	An array containing the HubDb table rows wrapped in a HubDbTableRowV3Wrapper object.
results[]	object	Each item	A HubDB table row in HubSpot's row wrapper (its shape is not published).
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	The total number of rows available in the collection. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
type	string	Required within parent	Indicates the type of response, which is 'RANDOM_ACCESS' by default. Known values: RANDOM_ACCESS Default: RANDOM_ACCESS

Referenced models: Get rows for a table — response body — type: RANDOM ACCESS paging

Get rows for a table — response body — type: STREAMING

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Return all draft tables — response body — paging
results	array	Required within parent	An array containing the HubDB table rows returned in the current response. Each item is a HubDbTableRowV3Wrapper object.
results[]	object	Each item	A HubDB table row in HubSpot's row wrapper (its shape is not published).
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	The total number of rows available in the collection. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
type	string	Required within parent	Indicates the type of response, which is 'STREAMING' by default. Known values: STREAMING Default: STREAMING

Referenced models: Return all draft tables — response body — paging

Get rows for a table — response body — type: RANDOM ACCESS paging

Field	Type	Presence	Description and constraints
$	object	Root
next	Model	Optional	Expand Get rows for a table — response body — type: RANDOM ACCESS paging next

Referenced models: Get rows for a table — response body — type: RANDOM ACCESS paging next

Return all draft tables — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
next	Model	Optional	Expand Get all tax rates — response body — paging next
prev	Model	Optional	Expand Return all draft tables — response body — paging prev

Referenced models: Get all tax rates — response body — paging next, Return all draft tables — response body — paging prev

Get rows for a table — response body — type: RANDOM ACCESS paging next

Field	Type	Presence	Description and constraints
$	object	Root
link	string	Optional	A URL that can be used to retrieve the next set of results.
offset	JSON	Required within parent
offset (anyOf 1)	integer	Alternative	The offset value indicating the starting point for the next set of results. Format: int32
offset (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get all tax rates — 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 paging cursor token for retrieving subsequent pages.
link	string	Optional	A URL that can be used to retrieve the next page results.

Return all draft tables — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	A paging cursor token for retrieving previous pages.
link	string	Optional	A URL that can be used to retrieve the previous pages' results.

Policy, approvals and errors

SDK function policy ID: hubspot.hubdb_get_rows. Catalog operation: hubdb_get_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