HubSpot: Return all draft tables

← Hubdb operations · Get started

Operation hubspot.hubdb_tables_get_hubdb_draft

Provider route: GET /cms/hubdb/2026-09/tables/draft. 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"]["tablesGetHubdbDraft"]>[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.tablesGetHubdbDraft(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.tables_get_hubdb_draft(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	Model	Optional	Expand Return all draft tables — request body — query

Referenced models: Return all draft tables — request body — query

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 Return all draft tables — response body

Referenced models: Return all draft tables — response body

Schemas

2 more schemas are linked from the tables above, on the schema pages.

Return all draft tables — response body

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 of HubDbTableV3 objects, each representing the details of a HubDB table.
results[]	Model	Each item	Expand Clone a table — response body
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	An integer representing the total number of HubDB tables available. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Return all draft tables — response body — paging, Clone a table — response body

Return all draft tables — request body — query

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
after	string	Optional
archived	boolean	Optional
contentType	string	Optional
createdAfter	string	Optional	Format: date-time
createdAt	string	Optional	Format: date-time
createdBefore	string	Optional	Format: date-time
isGetLocalizedSchema	boolean	Optional
limit	integer	Optional	Format: int32
sort	array	Optional
sort[]	string	Each item
updatedAfter	string	Optional	Format: date-time
updatedAt	string	Optional	Format: date-time
updatedBefore	string	Optional	Format: date-time

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

Clone a table — response body

Field	Type	Presence	Description and constraints
$	object	Root
allowChildTables	boolean	Required within parent	Specifies whether child tables can be created
allowPublicApiAccess	boolean	Required within parent	Specifies whether the table can be read by public without authorization
columnCount	JSON	Required within parent
columnCount (anyOf 1)	integer	Alternative	Number of columns including deleted Format: int64
columnCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
columns	array	Required within parent	List of columns in the table
columns[]	Model	Each item	Expand Clone a table — response body — columns item
createdAt	string	Required within parent	Timestamp at which the table is created Format: date-time
createdBy	Model	Optional	Expand Clone a table — response body — created By
deleted	boolean	Required within parent	Specifies whether the table is marked as deleted.
deletedAt	string	Required within parent	The timestamp indicating when the table was deleted. Format: date-time
dynamicMetaTags	object	Required within parent	Specifies the key value pairs of the [metadata fields](https://developers.hubspot.com/docs/cms/guides/dynamic-pages/hubdb#dynamic-pages) with the associated column IDs. Additional keys: see wildcard field
dynamicMetaTags.*	JSON	Additional keys
dynamicMetaTags.* (anyOf 1)	integer	Alternative	Format: int32
dynamicMetaTags.* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
enableChildTablePages	boolean	Required within parent	Specifies creation of multi-level dynamic pages using child tables
id	string	Required within parent	Id of the table
isOrderedManually	boolean	Optional	Indicates whether the table rows are ordered manually.
label	string	Required within parent	Label of the table
name	string	Required within parent	Name of the table
published	boolean	Required within parent	Indicates whether the table is currently published.
publishedAt	string	Required within parent	Timestamp at which the table is published recently Format: date-time
rowCount	JSON	Required within parent
rowCount (anyOf 1)	integer	Alternative	Number of rows in the table Format: int32
rowCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Required within parent	Timestamp at which the table is updated recently Format: date-time
updatedBy	Model	Optional	Expand Clone a table — response body — created By
useForPages	boolean	Required within parent	Specifies whether the table can be used for creation of dynamic pages

Referenced models: Clone a table — response body — columns item, Clone a table — response body — created By

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.

Clone a table — response body — created By

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent	The email address of the user.
firstName	string	Required within parent	The first name of the user.
id	string	Required within parent	The unique identifier for the user.
lastName	string	Required within parent	The last name of the user.

Clone a table — response body — columns item foreign Ids item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Unique identifier for the foreign ID.
name	string	Required within parent	Name of the foreign ID.
type	string	Required within parent	Type of the foreign ID.

Policy, approvals and errors

SDK function policy ID: hubspot.hubdb_tables_get_hubdb_draft. Catalog operation: hubdb_tables_get_hubdb_draft. 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.tables.read"]

Official provider source