HubSpot · Schema

DomainCollectionResponse

A paginated collection of domains

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
total integer The total number of domains
results array The list of domains
paging object Pagination information for forward navigation
View JSON Schema on GitHub

JSON Schema

hubspot-domains-domain-collection-response-schema.json Raw ↑
{
  "type": "object",
  "description": "A paginated collection of domains",
  "properties": {
    "total": {
      "type": "integer",
      "description": "The total number of domains",
      "format": "int32",
      "example": 2
    },
    "results": {
      "type": "array",
      "description": "The list of domains",
      "example": [
        {
          "id": "3210329704",
          "domain": "99558489.hubspot.com",
          "createdAt": "2017-07-11T13:00:52.928Z",
          "updatedAt": "2019-10-08T16:54:57.165Z",
          "isResolving": true,
          "isManuallyMarkedAsResolving": false,
          "isSslEnabled": true,
          "isSslOnly": false,
          "isPrimaryBlogPost": true,
          "isPrimarySitePage": false,
          "isPrimaryLandingPage": false,
          "isPrimaryEmail": false,
          "isPrimaryKnowledge": false,
          "isUsedForBlogPost": true,
          "isUsedForSitePage": false,
          "isUsedForLandingPage": false,
          "isUsedForEmail": false,
          "isUsedForKnowledge": false,
          "expectedCname": "99558489.group39.sites.hubspot.net",
          "redirectTo": "",
          "secondaryToDomain": "example.hubspot.com"
        }
      ],
      "items": {
        "type": "object",
        "description": "Represents a domain connected to a HubSpot CMS site",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier for the domain",
            "example": "3210329704"
          },
          "domain": {
            "type": "string",
            "description": "The actual domain or sub-domain (e.g., www.hubspot.com)",
            "example": "99558489.hubspot.com"
          },
          "createdAt": {
            "type": "string",
            "description": "When the domain was created",
            "format": "date-time",
            "example": "2017-07-11T13:00:52.928Z"
          },
          "updatedAt": {
            "type": "string",
            "description": "When the domain was last updated",
            "format": "date-time",
            "example": "2019-10-08T16:54:57.165Z"
          },
          "isResolving": {
            "type": "boolean",
            "description": "Whether the DNS for this domain is optimally configured for use with HubSpot",
            "example": true
          },
          "isManuallyMarkedAsResolving": {
            "type": "boolean",
            "description": "Whether the domain has been manually marked as resolving",
            "example": false
          },
          "isSslEnabled": {
            "type": "boolean",
            "description": "Whether SSL is enabled for this domain",
            "example": true
          },
          "isSslOnly": {
            "type": "boolean",
            "description": "Whether the domain only accepts HTTPS connections",
            "example": false
          },
          "isPrimaryBlogPost": {
            "type": "boolean",
            "description": "Whether this is the primary domain for blog posts",
            "example": true
          },
          "isPrimarySitePage": {
            "type": "boolean",
            "description": "Whether this is the primary domain for site pages",
            "example": false
          },
          "isPrimaryLandingPage": {
            "type": "boolean",
            "description": "Whether this is the primary domain for landing pages",
            "example": false
          },
          "isPrimaryEmail": {
            "type": "boolean",
            "description": "Whether this is the primary domain for email web pages",
            "example": false
          },
          "isPrimaryKnowledge": {
            "type": "boolean",
            "description": "Whether this is the primary domain for knowledge base",
            "example": false
          },
          "isUsedForBlogPost": {
            "type": "boolean",
            "description": "Whether the domain is used for CMS blog posts",
            "example": true
          },
          "isUsedForSitePage": {
            "type": "boolean",
            "description": "Whether the domain is used for CMS site pages",
            "example": false
          },
          "isUsedForLandingPage": {
            "type": "boolean",
            "description": "Whether the domain is used for CMS landing pages",
            "example": false
          },
          "isUsedForEmail": {
            "type": "boolean",
            "description": "Whether the domain is used for CMS email web pages",
            "example": false
          },
          "isUsedForKnowledge": {
            "type": "boolean",
            "description": "Whether the domain is used for CMS knowledge pages",
            "example": false
          },
          "expectedCname": {
            "type": "string",
            "description": "The expected CNAME record for this domain",
            "example": "99558489.group39.sites.hubspot.net"
          },
          "redirectTo": {
            "type": "string",
            "description": "The domain to redirect to, if any",
            "example": ""
          },
          "secondaryToDomain": {
            "type": "string",
            "description": "The primary domain this domain is secondary to",
            "example": "example.hubspot.com"
          }
        },
        "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",
              "example": "NTI1Cg%3D%3D"
            },
            "link": {
              "type": "string",
              "description": "A direct link to the next page",
              "example": "?after=NTI1Cg%3D%3D"
            }
          },
          "required": [
            "after"
          ]
        }
      }
    }
  },
  "required": [
    "total",
    "results"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "DomainCollectionResponse"
}