HubSpot · JSON Structure

Hubspot Domains Domain Collection Response Structure

A paginated collection of domains

Type: object Properties: 3 Required: 2

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

DomainCollectionResponse is a JSON Structure definition published by HubSpot, describing 3 properties, of which 2 are required. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

total results paging

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

{
  "type": "object",
  "description": "A paginated collection of domains",
  "name": "DomainCollectionResponse",
  "properties": {
    "total": {
      "type": "integer",
      "description": "The total number of domains"
    },
    "results": {
      "type": "array",
      "description": "The list of domains",
      "items": {
        "type": "object",
        "description": "Represents a domain connected to a HubSpot CMS site",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier for the domain"
          },
          "domain": {
            "type": "string",
            "description": "The actual domain or sub-domain (e.g., www.hubspot.com)"
          },
          "createdAt": {
            "type": "datetime",
            "description": "When the domain was created"
          },
          "updatedAt": {
            "type": "datetime",
            "description": "When the domain was last updated"
          },
          "isResolving": {
            "type": "boolean",
            "description": "Whether the DNS for this domain is optimally configured for use with HubSpot"
          },
          "isManuallyMarkedAsResolving": {
            "type": "boolean",
            "description": "Whether the domain has been manually marked as resolving"
          },
          "isSslEnabled": {
            "type": "boolean",
            "description": "Whether SSL is enabled for this domain"
          },
          "isSslOnly": {
            "type": "boolean",
            "description": "Whether the domain only accepts HTTPS connections"
          },
          "isPrimaryBlogPost": {
            "type": "boolean",
            "description": "Whether this is the primary domain for blog posts"
          },
          "isPrimarySitePage": {
            "type": "boolean",
            "description": "Whether this is the primary domain for site pages"
          },
          "isPrimaryLandingPage": {
            "type": "boolean",
            "description": "Whether this is the primary domain for landing pages"
          },
          "isPrimaryEmail": {
            "type": "boolean",
            "description": "Whether this is the primary domain for email web pages"
          },
          "isPrimaryKnowledge": {
            "type": "boolean",
            "description": "Whether this is the primary domain for knowledge base"
          },
          "isUsedForBlogPost": {
            "type": "boolean",
            "description": "Whether the domain is used for CMS blog posts"
          },
          "isUsedForSitePage": {
            "type": "boolean",
            "description": "Whether the domain is used for CMS site pages"
          },
          "isUsedForLandingPage": {
            "type": "boolean",
            "description": "Whether the domain is used for CMS landing pages"
          },
          "isUsedForEmail": {
            "type": "boolean",
            "description": "Whether the domain is used for CMS email web pages"
          },
          "isUsedForKnowledge": {
            "type": "boolean",
            "description": "Whether the domain is used for CMS knowledge pages"
          },
          "expectedCname": {
            "type": "string",
            "description": "The expected CNAME record for this domain"
          },
          "redirectTo": {
            "type": "string",
            "description": "The domain to redirect to, if any"
          },
          "secondaryToDomain": {
            "type": "string",
            "description": "The primary domain this domain is secondary to"
          }
        },
        "required": [
          "id",
          "domain",
          "isResolving",
          "isUsedForBlogPost",
          "isUsedForSitePage",
          "isUsedForLandingPage",
          "isUsedForEmail",
          "isUsedForKnowledge"
        ]
      }
    },
    "paging": {
      "type": "object",
      "description": "Pagination information for forward navigation",
      "properties": {
        "next": {
          "type": "object",
          "description": "Information about the next page of results",
          "properties": {
            "after": {
              "type": "string",
              "description": "The cursor token for the next page"
            },
            "link": {
              "type": "string",
              "description": "A direct link to the next page"
            }
          },
          "required": [
            "after"
          ]
        }
      }
    }
  },
  "required": [
    "total",
    "results"
  ],
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}