HubSpot · Schema

CollectionResponseHubDBTable

A paginated list of HubDB tables.

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
results array
paging object Pagination information.
View JSON Schema on GitHub

JSON Schema

hubspot-cms-hubdb-collection-response-hub-db-table-schema.json Raw ↑
{
  "type": "object",
  "description": "A paginated list of HubDB tables.",
  "properties": {
    "results": {
      "type": "array",
      "example": [
        {
          "id": "500123",
          "name": "Example Record",
          "label": "Example Record",
          "columns": [
            {
              "id": "500123",
              "name": "Example Record",
              "label": "Example Record",
              "type": "TEXT",
              "options": [
                {}
              ]
            }
          ],
          "published": true,
          "rowCount": 10,
          "createdAt": "2025-03-15T14:30:00Z",
          "updatedAt": "2025-03-15T14:30:00Z",
          "publishedAt": "2025-03-15T14:30:00Z"
        }
      ],
      "items": {
        "type": "object",
        "description": "A HubDB table.",
        "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.",
            "example": [
              {
                "id": "500123",
                "name": "Example Record",
                "label": "Example Record",
                "type": "TEXT",
                "options": [
                  {}
                ]
              }
            ],
            "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.",
                  "example": "TEXT",
                  "enum": [
                    "TEXT",
                    "NUMBER",
                    "URL",
                    "IMAGE",
                    "SELECT",
                    "MULTISELECT",
                    "BOOLEAN",
                    "LOCATION",
                    "DATE",
                    "DATETIME",
                    "CURRENCY",
                    "RICHTEXT",
                    "FOREIGN_ID"
                  ]
                },
                "options": {
                  "type": "array",
                  "description": "Available options for SELECT and MULTISELECT columns.",
                  "example": [
                    {}
                  ],
                  "items": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "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",
            "description": "The date and time the table was created.",
            "format": "date-time",
            "example": "2025-03-15T14:30:00Z"
          },
          "updatedAt": {
            "type": "string",
            "description": "The date and time the table was last updated.",
            "format": "date-time",
            "example": "2025-03-15T14:30:00Z"
          },
          "publishedAt": {
            "type": "string",
            "description": "The date and time the table was last published.",
            "format": "date-time",
            "example": "2025-03-15T14:30:00Z"
          }
        }
      }
    },
    "paging": {
      "type": "object",
      "description": "Pagination information.",
      "properties": {
        "next": {
          "type": "object",
          "example": {
            "after": "example-value"
          },
          "properties": {
            "after": {
              "type": "string"
            }
          }
        }
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "CollectionResponseHubDBTable"
}