HubSpot · Schema

HubDBTable

A HubDB table.

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
id string The unique identifier for the table.
name string The machine-readable name of the table.
label string The human-readable label for the table.
columns array The column definitions for the table.
published boolean Whether the table has been published.
rowCount integer The number of rows in the published table.
createdAt string The date and time the table was created.
updatedAt string The date and time the table was last updated.
publishedAt string The date and time the table was last published.
View JSON Schema on GitHub

JSON Schema

cms-hubdb-api-hub-dbtable-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/cms-hubdb-api-hub-dbtable-schema.json",
  "title": "HubDBTable",
  "description": "A HubDB table.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for the table.",
      "example": "500123"
    },
    "name": {
      "type": "string",
      "description": "The machine-readable name of the table.",
      "example": "Example Record"
    },
    "label": {
      "type": "string",
      "description": "The human-readable label for the table.",
      "example": "Example Record"
    },
    "columns": {
      "type": "array",
      "description": "The column definitions for the table.",
      "items": {
        "type": "object",
        "description": "A column definition in a HubDB table.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier for the column.",
            "example": "500123"
          },
          "name": {
            "type": "string",
            "description": "The machine-readable name of the column.",
            "example": "Example Record"
          },
          "label": {
            "type": "string",
            "description": "The human-readable label for the column.",
            "example": "Example Record"
          },
          "type": {
            "type": "string",
            "description": "The data type of the column.",
            "enum": [
              "TEXT",
              "NUMBER",
              "URL",
              "IMAGE",
              "SELECT",
              "MULTISELECT",
              "BOOLEAN",
              "LOCATION",
              "DATE",
              "DATETIME",
              "CURRENCY",
              "RICHTEXT",
              "FOREIGN_ID"
            ],
            "example": "TEXT"
          },
          "options": {
            "type": "array",
            "description": "Available options for SELECT and MULTISELECT columns.",
            "items": {
              "type": "object"
            },
            "example": [
              {}
            ]
          }
        }
      },
      "example": [
        {
          "id": "500123",
          "name": "Example Record",
          "label": "Example Record",
          "type": "TEXT",
          "options": [
            {}
          ]
        }
      ]
    },
    "published": {
      "type": "boolean",
      "description": "Whether the table has been published.",
      "example": true
    },
    "rowCount": {
      "type": "integer",
      "description": "The number of rows in the published table.",
      "example": 10
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the table was created.",
      "example": "2025-03-15T14:30:00Z"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the table was last updated.",
      "example": "2025-03-15T14:30:00Z"
    },
    "publishedAt": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the table was last published.",
      "example": "2025-03-15T14:30:00Z"
    }
  }
}