Sign in

v3

latestOpenAPI 3.0.12026-07-133132111.2 KB
Tables

Get details of a published table

Returns the details for the published version of the specified table. This will include the definitions for the columns in the table and the number of rows in the table.

Note: This endpoint can be accessed without any authentication if the table is set to be allowed for public access. To do so, you'll need to include the HubSpot account ID in a portalId query parameter.

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

Path parameters

tableIdOrNamestring required

The ID or name of the table to return.

Query parameters

archivedboolean

Set this to true to return details for an archived table. Defaults to false.

includeForeignIdsboolean

Set this to true to populate foreign ID values in the result.

isGetLocalizedSchemaboolean

Indicates whether to retrieve the localized schema for the tables.

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