CMS API | HubDB
HubDB is a relational data store that presents data as rows, columns, and cells in a table, much like a spreadsheet. HubDB tables can be added or modified within your HubSpot account, but you can also use the API endpoints documented here. For information on using data from HubDB tables on your website or in programmable emails, check out HubSpot's CMS developer documentation.
Similar to HubSpot website pages, HubDB tables support draft
and published
versions. This allows you to update data in the table, either for testing or to allow for a manual approval process, without affecting any live pages. Learn more about drafted versus live tables.
If a table is set to be allowed for public access, you can access the published version of the table and rows without any authentication by specifying your HubSpot account ID via the query parameter portalId
.
If you're migrating from v2 of the HubDB API, learn more about the changes in the current (v3) API.
Please note: endpoints that support GET
also support CORS
, so you can access data in a table client-side using JavaScript and your account ID. Other methods and the Get all tables endpoint require authentication and do not support CORS
.
HubDB API requests have different rate limits, depending on the type of request:
- Any
GET
requests made that don't require authentication (including client-side JavaScript requests) are limited to 10 requests per second. These requests won't count towards the daily limit. - All other requests using authentication follow the standard limits.
HubDB tables have both draft and live versions and live versions can be published or unpublished. This will allow you to update data in the table, either for page previews or testing or to allow for a manual approval process, without affecting any live pages.
In this API, separate endpoints are designated for the draft and published versions of a table. For example, you can retrieve the published version of a table by making a GET
request to the following endpoint:
/cms/v3/hubdb/tables/{tableIdOrName}
And to retrieve any content that has been drafted but not yet published, you would add /draft
to the end of the URL:
/cms/v3/hubdb/tables/{tableIdOrName}/draft
Draft data can be reviewed and then pushed in HubSpot, or with the /push-live
endpoint. The draft data can also be discarded via /reset
endpoint, allowing you to revert to the current live version of the data without disruption.
To create a HubDB table, make a POST
request to /cms/v3/hubdb/tables
.
In the request body, specify the following required fields:
Field | Type | Description | Example |
---|---|---|---|
name
| String | The internal name of the table. This name cannot be changed once the table is created. Names can only include lowercase letters, digits, and underscores and cannot begin with a number. |
"name": "my_table"
|
label
| String | The label of the table that users see when editing the table in HubSpot. |
"label":"My table"
|
In addition, you can specify the following optional fields:
Field | Type | Description | Example |
---|---|---|---|
useForPages
| Boolean | Whether the table can be used for creating dynamic pages. |
"useForPages": false
|
allowPublicAPIAccess
| Boolean | Whether the table can be read without authorization. |
"allowPublicApiAccess": false
|
allowChildTables
| Boolean | Whether child tables can be created for the table. |
"allowChildTables": false
|
enableChildTablePages
| Boolean | Whether multilevel dynamic pages should be created using child tables. |
"enableChildTablePages": false
|
columns
| Object | The columns of the table. Learn more about column properties in the Add table columns sections. |
See "Add table columns" section below
|
Without any columns added yet, your create request might look like the following:
Each column in a HubDB table can be defined with the following properties:
Field | Type | Description | Example |
---|---|---|---|
name
| String | Required. The internal name of the column. Cannot be changed after the column is created. |
"name": "row_name"
|
label
| String | Optional. The label for the column that users will see when editing the table in HubSpot. |
"label": "Row label"
|
type
| String | The data type of the column. Must be one of the following:
|
"type": "type"
|
options
| Object | A list of options for select and multiselect columns. Each option is defined with a |
"option": [{"name":"Option 1", "type":"option"}, {"name": "Option 2", "type": "option"}]
|
Using the above fields, your request to create a new HubDB table might look like the following:
// Example request
{
"label": "Test Table",
"name": "test_table",
"columns": [
{
"name": "text_column",
"label": "Text Column",
"archived": false,
"type": "TEXT"
},
{
"name": "number_column",
"label": "Number Column",
"archived": false,
"type": "NUMBER"
},
{
"name": "multiselect",
"label": "Multi Select Column",
"archived": false,
"type": "multiselect",
"options": [
{
"name": "Option 1",
"type": "option"
},
{
"name": "Option 2",
"type": "option"
}
]
}
],
"useForPages": true,
"allowChildTables": true,
"enableChildTablePages": false,
"allowPublicApiAccess": false
}
After creating a table, columns will be assigned IDs in ascending order. When updating existing columns, include the column's id
field in the input object.
You can add rows either manually through the API, or you can import rows from a CSV file.
To add rows to a HubDB table, make a POST
request to /cms/v3/hubdb/tables/{tableIdOrName}/rows
.
For each table row, you can include the following fields:
Field | Type | Description | Example |
---|---|---|---|
values
| Object | A list of key-value pairs with the column name and the value you want to add to it. |
"values": {
"text_column": "sample text",
"number_column": 76}
|
path
| String | For tables enabled for dynamic pages, |
"path": "example_url_path"
|
name
| String | For tables enabled for dynamic pages, |
"name": "Example Title"
|
childTableId
| Number | When creating multilevel dynamic pages, |
"childTableId": 123456
|
Using the above fields, your request might look similar to the following:
To import data into a HubDB table from a CSV file, make a POST
request to /cms/v3/hubdb/tables/{tableIdOrName}/draft/import
.
The import endpoint takes a multipart/form-data
POST
request:
config
: a set of JSON-formatted options for the import.file
: the CSV file that you want to import.
In config
, include the following fields as a JSON string:
Field | Type | Description | Example |
---|---|---|---|
skipRows
| Number | The number of header rows that should be skipped over. This field defaults to |
"skipRows": 0
|
separator
| String | The column delimiter in the CSV file. Set to |
"separator": ","
|
idSourceColumn
| Number | The index of the column in the source file containing the row’s ID ( If this column is specified, the import will update the existing rows in the table for the matching row IDs from the CSV file. This is optional and you can ignore this during the first time you import data into a table. See the Reset options section below more detailed information. |
"idSourceColumn": 1
|
resetTable
| Boolean | Defaults to See the Reset options section below more detailed information. |
"resetTable": true
|
nameSourceColumn
| Number | For tables enabled for dynamic pages, |
"nameSourcecolumn": 5
|
pathSourceColumn
| Number | For tables enabled for dynamic pages, |
"pathSourcecolumn": 6
|
childTableSourceColumn
| Number | Specifies the column in the CSV file that contains the row's |
"childTableSourcecolumn": 3
|
columnMappings
| Array | A list of mappings for the columns in the source file to the columns in the destination HubDB table. Each mapping must have the following format:
If your file has an |
"columnMappings": [{"source":1, "target": 2}, {"source": 2, "target": "column_name"}]
|
primaryKeyColumn
| String | The name of a column in the target HubDB table that will be used for deduplication. The column's ID cannot be used for this field. |
"primaryKeyColumn": "column_name"
|
encoding
| String | The file's encoding type. For example, |
"encoding": "utf-8"
|
format
| String | Only CSV is supported. |
"format": "csv"
|
Using the above table, your config
JSON might look like the following:
If using cURL, your command might look like the following:
There are several formats you can use when importing data into a date-type column.
Integers
yyyy/mm/dd
yyyy/mm/dd
mm/dd/yyyy
mm/dd/yy
These formats require the month to precede the day (i.e., dd/mm/yy
is not accepted). Integers can be separated by hyphens (-
) or slashes (/
).
Relaxed dates
You can also import date formats that are less standardized than integer-based dates. For example:
The 1st of March in the year 2022
Fri Mar 4 2022
March 4th '22
Relative dates
HubSpot will parse the following date formats relative to the current day:
next Thursday
Today
tomorrow
3 days from now
When importing data from a CSV file into a HubDB table, you can set the resetTable
field to true
or false
(default) to manage whether HubDB row data is overwritten.
- If
resetTable
is set totrue
:
- If the rows in the CSV file does not have a row ID column (
hs_id
or row ID is specified as0
, those rows will be inserted with the new row IDs generated. - If the row IDs in the CSV file already exists in the target table, the existing rows in the table will be updated with the new values from the input file.
- If the table has rows but the input CSV file does not have those row IDs, those rows will be deleted from the target table.
- If the row IDs in the input CSV file do not exist in the target table, those rows will be inserted with the new row IDs generated and the row IDs given in the input file will be ignored.
- If the input CSV file does not contain the row ID column at all, all the rows will be deleted from the target table and the rows from the input file will be inserted with the new row IDs generated.
- If the rows in the CSV file does not have a row ID column (
- If
resetTable
is set tofalse
(default):
- If the row IDs in the CSV file already exists in the target table, the existing rows in the table will be updated with the new values from the input file.
- If the table has rows but the input CSV file does not have those row IDs, those rows will not be deleted from the target table and those rows will remain unchanged.
- If the row IDs in the input CSV file do not exist in the target table, those rows will be inserted with the new row IDs generated and the row IDs given in the input file will be ignored.
- If the rows in the CSV file does not have a row ID column or row ID is specified as
0
, those rows will be inserted with the new row IDs generated.
There are multiple ways to retrieve HubDB data, depending on whether you're looking for table details or the rows of a table:
- To retrieve table details from all published tables, make a
GET
request to/cms/v3/hubdb/tables
. - To retrieve table details from a specific published table, make a
GET
request to/cms/v3/hubdb/tables{tableIdOrName}
. - To retrieve all rows from a specific table, make a
GET
request to/cms/v3/hubdb/tables{tableIdOrName}/rows
. - To retrieve a specific row from a table, make a
GET
request to/cms/v3/hubdb/tables{tableIdOrName}/rows/{rowId}
.
When retrieving row data, you can further filter and sort the results.
If a table is set to be allowed for public access, you can access the published version of the table and rows without any authentication by specifying your HubSpot account ID via the query parameter portalId
.
When retrieving HubDB table data, you can apply filters as query parameters to receive specific data. Filter query parameters are constructed as follows: columnName__operator
.
For example, if you have a number column named bar, you can filter results to only include rows where bar is greater than 10: &bar__gt=10
.
All filters are ANDed together (OR filters are not currently supported).
When filtering, keep the following in mind:
- When passing values for
multiselect
columns, the values should be comma-separated (e.g.multiselect_column__contains=1,2
). - For
datetime
filters, you can use relative dates in place of timestamps in order to specify a value relative to the current time. For example,-3h
would correspond to the timestamp 3 hours before now, whereas10s
would correspond to 10 seconds in the future. Supported time units are ms (milliseconds), s (seconds), m (minutes), h (hours), d (days). Current time can be used by specifying a zero value: 0s
- For the purposes of these filters, the built in column
hs_id
is anumber
column, thehs_created_at
column is adatetime
, and thehs_path
andhs_name
columns aretext
columns.
Below, learn which operators can be applied to which column types:
Operator | Name | Description |
---|---|---|
eq (or none)
| Equals | All column types. This filter is applied if no operator is used. When used with multiselect columns, returns rows that exact match supplied values. |
ne
| Not equal to | All column types. |
contains
| Contains | Text, richtext, and multiselect. When used with multiselect columns, returns rows that contain all of the supplied values. This filter is case sensitive. |
lt
| Less than | Number, date, and datetime. |
lte
| Less than or equal to | Number, date, and datetime. |
gt
| Greater than | Number, date, and datetime. |
gte
| Greater than or equal to | Number, date, and datetime. |
is_null
| Null | All column types except boolean. This filter doesn't require a value (e.g. |
not_null
| Not null | All column types except boolean. This filter doesn't require a value (e.g. |
like
| Like | Text and richtext. |
not_like
| Not like | Text and richtext. |
icontains
| Contains | Text and richtext. This filter is case insensitive. |
startswith
| Starts with | Text and richtext. |
in
| In | Number, select, and multiselect. Returns rows where the column includes at least one of the passed options. When there is no other |
When retrieving HubDB data, you can apply sorting as a query parameter to determine the order of the returned data. To sort data, add a sort
query parameter and specify the column name:
&sort=columnName
By default, data will be returned in the natural order of the specified column. You can reverse the sort by adding a -
to the column name:
&sort=-columnName
You can include this parameter multiple times to sort by multiple columns.
In addition to sorting by a column, there are three functions that can be used:
- geo_distance(location_column_name, latitude, longitude): takes the name of a location column and coordinates, returns the rows ordered by how far away the values of the specified location column are from the provided coordinates.
- length(column_name): takes the name of a column, returns the rows ordered by the length of the column value (calculated as a string)
- random(): returns the rows in random order.
These functions also support reverse ordering. For example, the following geo_distance
sort returns items that are the farthest away first:
sort=-geo_distance(location_column,42.37,-71.07)
Using HubSpot's CMS, you can use a HubDB table as a data source to generate dynamic pages. For example, you can create a table that contains a row for each member of your executive team, with columns containing information that you want to display on a page. After selecting that table as the dynamic data source for a page, that page will generate a listing page that displays all rows as summary items, along with separate pages for each row, similar to a blog listing page and blog post pages.
To enable a table to be selected as a data source in the content editor, you'll need to set useForPage
to true
. You can optionally include dynamicMetaTags
to specify which columns to use for each page's metadata.
dynamicMetaTags
, you'll need to ensure that the page is using page_meta
HubL tags instead of content
. Learn more in the dynamic pages guide.
For example, the code below would create a table that can be used for dynamic pages, and specifies the three columns to use for page metadata.
Parameter | Type | Description |
---|---|---|
useForPages
| Boolean | Set to |
dynamicMetaTags
| Object | Specifies the columns by ID to use for metadata on each dynamic page. Can contain:
For any metadata fields not specified, pages will inherit the respective values from its parent page. |
DESCRIPTION
| Number | The numeric ID of the column to use for each page's meta description. |
FEATURED_IMAGE_URL
| Number | The numeric ID of the column to use for each page's featured image URL. |
LINK_REL_CANONICAL_URL
| Number | The numeric ID of the column to use for each page's canonical URL. |
- Tables should have both
name
andlabel
. This name cannot be changed once the table is created. Names can only include lowercase letters, digits, and underscores and cannot begin with a number. Bothname
andlabel
should be unique in the account. - API supports both table
id
andname
in the URL paths. GET
row endpoints return columnname
instead ofid
invalues
field. Also,POST
/PUT
/PATCH
row endpoints require columnname
instead ofid
invalues
field.- Row update
PATCH
endpoints now accept sparse updates, which means you can specify only the column values that you need to update (whereas you had to specify all the column values in the previous versions). When you update a column with a list of values such as multiselect, you need to specify the list of all the values. In order to delete the value for a column, you need to specify the column with the value asnull
in the request. - Removed the endpoints to
get
/update
/delete
a row cell in favor of the row updatePATCH
endpoints. - Import endpoint now supports an optional field
idSourceColumn
along with existing fields in the JSON-formatted options. You can use this field to specify the column in the csv file which contains row ids. To import new rows along with the new values for existing rows, you can simply specify0
as the row id for the new rows and the valid row ids for the existing columns. See more details in the Import section below. Also you can use column names or ids in the target field of the column mappings in the JSON-formatted options. - Clone endpoint requires a new name and new label.
Thank you for your feedback, it means a lot to us.