HubDB
Marketing Hub
- Enterprise
CMS Hub
- Professional or Enterprise
HubDB is a tool that allows you to create tables to store data in rows, columns, and cells, much like a spreadsheet. You can customize a HubDB table's columns, rows, and other settings based on your needs.
HubDB tables can be accessed both within HubSpot and through the HubDB API. For example, you could use a HubDB table to store feedback from an external mechanism to retrieve at a later time.
HubDB data can then be retrieved a few ways, depending on your use case. To get data from a HubDB table, you can:
- Query the data externally via the HubDB API
- Use HubSpot’s HubL markup tags to pull data into the CMS.
- Use the HubDB API with serverless functions to provide an interactive web app experience.
Please note: if you have a Marketing Hub Enterprise account, you can use HubDB to render content in marketing emails. However, you cannot use contact properties to filter HubDB tables in emails.
To use HubDB data in pages, you need CMS Hub Professional or Enterprise.
There are two types of access you can assign to a user in order for them to be able to make use of HubDB. Both of these settings are located inside of a user's permissions area. To assign access, go to Settings > Users & Teams and hover over a user. Then, choose "Edit" from the Actions Menu.
- 10,000 rows per HubDB table.
- 1000 HubDB tables per account.
- 10 table scans per CMS page. Defined as a single call to
hubdb_table_rows()
- HubSpot’s general API limits
- HubDB's with dynamic pages turned on must have lowercase paths. This makes it so URLs to these pages can be case insensitive.
Open up the HubDB editor app and click the "Create Table" button (or use the APIs create table endpoint).
Note: All new tables created are set with a status of draft. They cannot be used to output data via HubL or API until you publish the table.

You can manage your HubDB tables settings by clicking "Actions", then "Manage Settings". The following settings are available:
- Allow public API access: [On by default] When this option is toggled off, your table contents can only be viewed in the app or with authenticated APIs. When toggled on, your table can be queried by unauthenticated APIs.
- Enable creation of dynamic pages using row data: With dynamic pages, HubDB allows you to create a page for every row in your table. Upon toggling this option on, you will then be able to select columns of you HubDB table that will serve as the source for your Meta Description, Featured Image, and Canonical URL.
- If using dynamic pages, you can also choose to select Child Tables. Learn more about building multilevel dynamic pages using HubDB.

A table is a 2-dimensional arrangement of rows and columns. When a table is created, it is given a globally unique ID which can be used to identify it.
Rows are horizontal slices of a table. All the values in a row are related, usually to a single primary identifier. In a spreadsheet application, rows are represented by numbers, starting with 1. Each table row is given a globally unique ID on creation.
Columns are vertical slices of a table. Each column has a type. In a spreadsheet application, they're represented by alphabetic columns like A, B, C, etc. There are two types of table columns:
Each row in a table has a couple of built-in columns:
Column | Description |
---|---|
hs_id
| An automatically assigned, globally unique, numeric ID for this row. |
hs_created_at
| A timestamp of when this row was created. |
hs_path
| When used with dynamic pages, this string is the last segment of the URL's path for the page. |
hs_name
| When used with dynamic pages, this is the title of the page. |
Note: As of October 1st, 2020, Rich Text Area columns in HubDB are limited to 65,000 characters. For more information, please view our changelog regarding this change.
Tables can have as many custom columns as you'd like. They can be text, rich text, numbers, currency, dates, times, images, videos, selects or locations (latitude and longitude).
When a column is created, it is given a numeric id unique to the table, starting at value 1. Column IDs are increasing, but not necessarily sequential. Column IDs cannot be reused, so if a table has 2 columns, 1 and 2, and the 2nd column is deleted, the next column created will have ID 3.
Cells store the values where a row and column intersect. Cells can be read or updated individually or as part of a row. Setting the value of a cell to null
is equivalent to deleting the cell's value.
You can query tables from HubL and iterate over the results. To list rows of a table, use the hubdb_table_rows()
HubL function. You can either access a table by its ID or name. It is recommended to reference a HubDB table by name, as this can help with code portability across HubSpot accounts. The immutable table name is set when creating a new table and can be found at any time by selecting Actions > Manage Settings within the table editor. A table's ID can be found in the address bar of the table editor or in the HubDB tables dashboard under the "ID" column.

Below is an example of using hubdb_table_rows()
to fetch data.
<filterQuery>
uses the same syntax as the HTTP API. For example, hubdb_table_rows(123, "employees__gt=10&orderBy=count")
would return a list of rows where the "employees" column is greater than 10, ordered by the "count" column. A complete list of optional <filterQuery>
parameters can be found here.
NOTE: Instead of using multiple row queries with different <filterQuery>
parameters, you should make one query and use the selectattr()
or rejectattr()
filters to filter your rows:
To get a single row, use the hubdb_table_row()
HubL function.
Built-in and custom column names are case insensitive. HS_ID
will work the same as hs_id
.
Attribute | Description |
---|---|
row.hs_id
| The globally unique id for this row. |
row.hs_path
| When using dynamic pages, this string is the Page Path column value and the last segment of the url's path. |
row.hs_name
| When using dynamic pages, this string is the Page Title column value for the row. |
row.hs_created_at
| Unix timestamp for when the row was created. |
row.hs_child_table_id
| When using dynamic pages, this is the ID of the other table that is populating data for the row. |
row.column_name
| Get the value of the custom column by the name of the column. |
row["column name"]
| Get the value of the custom column by the name of the column. |
To get information on a table including its name, columns, last updated, etc, use the hubdb_table()
function.
The attributes listed below are in reference to the variable that hubdb_table()
was assigned to in the above code. Your variable may differ.
Note: It is recommended assigning this to a variable for easier use. If you don't want to do that, you can use{{ hubdb_table(<tableId>).attribute }}
Attribute | Description |
---|---|
table_info.id
| The id of the table. |
table_info.name
| The name of the table. |
table_info.columns
| List of column information. You can use a for loop to iterate through the information available in this attribute. |
table_info.created_at
| Timestamp of when the table was first created. |
table_info.published_at
| Timestamp of when this table was published. |
table_info.updated_at
| Timestamp of when this table was last updated. |
table_info.row_count
| Number of rows in the table. |
To get information on a column in table such as its label, type and options, use the hubdb_table_column()
function
The attributes listed below are in reference to the variable that hubdb_table_column()
was assigned to in the above code. Your variable may differ.
Note: It is recommended assigning this to a variable for easier use. If you don't want to do that, you can use{{ hubdb_table_column(<tableId>,<columnId or column name>).attribute }}
Attribute | Description |
---|---|
table_info.id
| The ID of the column. |
table_info.name
| The name of the column. |
table_info.label
| The label to be used for the column. |
table_info.type
| Type of this column. |
table_info.options
| For select column type, this is a map of |
table_info.foreignIds
| For foreignId column types, a list of foreignIds (with |
Method | Description |
---|---|
getOptionByName("<option name")
| For select column types, get option information by the options name. |
The richtext
column type functions similar to the rich text field you see for modules. The data stored is HTML the HubDB UI provides a text editing interface. One notable difference though is that the HubDB UI does not allow direct source code editing for the rich text fields. This prevents situations where a non technical user may input invalid html, preventing unintended issues with the appearance or functionality of your site. For situations where you need an embed code or more custom HTML you can use the embed feature in the rich text editor to place your custom code.
If you would like to manage your HubDB data externally, or using serverless functions, you can use our REST APIs found here
Thank you for your feedback, it means a lot to us.