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

cms-hubdb-api-collection-response-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-collection-response-hub-dbtable-schema.json",
  "title": "CollectionResponseHubDBTable",
  "description": "A paginated list of HubDB tables.",
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "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.",
            "items": {
              "$ref": "#/components/schemas/HubDBColumn"
            },
            "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"
          }
        }
      },
      "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"
        }
      ]
    },
    "paging": {
      "type": "object",
      "description": "Pagination information.",
      "properties": {
        "next": {
          "type": "object",
          "properties": {
            "after": {
              "type": "string"
            }
          },
          "example": {
            "after": "example-value"
          }
        }
      }
    }
  }
}