HUhubspot
Tables

Get details for a draft table

Changed on

Get the details for the draft version of a specific HubDB table. This will include the definitions for the columns in the table and the number of rows in the table.

get/cms/hubdb/2026-03/tables/{tableIdOrName}/draft

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/cms/hubdb/2026-03/tables/{tableIdOrName}/draft
  • Auth
    • OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: hubdb
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: hubdb.tables.read

Path parameters

tableIdOrNamestring required

The unique identifier or name of the table to retrieve the draft for.

Query parameters

archivedboolean

Whether to return only results that have been archived.

includeForeignIdsboolean

Include foreign IDs in the response if set to true.

isGetLocalizedSchemaboolean

Whether to retrieve the localized schema if available.

Response

successful operation

allowChildTablesboolean required

Specifies whether child tables can be created

allowPublicApiAccessboolean required

Specifies whether the table can be read by public without authorization

columnCountinteger required

Number of columns including deleted

createdAtstring date-time required

Timestamp at which the table is created

deletedboolean required

Specifies whether the table is marked as deleted.

deletedAtstring date-time required

The timestamp indicating when the table was deleted.

dynamicMetaTagsobject required

Specifies the key value pairs of the metadata fields with the associated column IDs.

enableChildTablePagesboolean required

Specifies creation of multi-level dynamic pages using child tables

idstring required

Id of the table

isOrderedManuallyboolean

Indicates whether the table rows are ordered manually.

labelstring required

Label of the table

namestring required

Name of the table

publishedboolean required

Indicates whether the table is currently published.

publishedAtstring date-time required

Timestamp at which the table is published recently

rowCountinteger required

Number of rows in the table

updatedAtstring date-time required

Timestamp at which the table is updated recently

useForPagesboolean required

Specifies whether the table can be used for creation of dynamic pages

Changes

  • 2026-0357dfaa14c811Revision changes
    • info

      the security scope hubdb was added to the endpoint's security scheme oauth2

    • info

      the security scope hubdb.tables.read was removed from the endpoint's security scheme oauth2

  • 2026-0308b7d0c88aa0Revision changes
    • info

      the security scope hubdb.tables.read was added to the endpoint's security scheme oauth2

    • info

      the security scope hubdb-schemas-read was removed from the endpoint's security scheme oauth2