HubSpot · Schema

HubDBColumn

A column definition in a HubDB table.

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
id string The unique identifier for the column.
name string The machine-readable name of the column.
label string The human-readable label for the column.
type string The data type of the column.
options array Available options for SELECT and MULTISELECT columns.
View JSON Schema on GitHub

JSON Schema

cms-hubdb-api-hub-dbcolumn-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-dbcolumn-schema.json",
  "title": "HubDBColumn",
  "description": "A column definition in a HubDB table.",
  "type": "object",
  "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": [
        {}
      ]
    }
  }
}