HubSpot: Get a single domain

← Domains operations · Get started

Operation hubspot.domains_get_domain

Provider route: GET /cms/domains/2026-09/{domainId}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["domains"]["getDomain"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.domains.getDomain(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.domains.get_domain(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.domainId	string	Required within parent

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get a single domain — response body

Referenced models: Get a single domain — response body

Schemas

Get a single domain — response body

Field	Type	Presence	Description and constraints
$	object	Root
correctCname	string	Required within parent	The expected CNAME record for the domain.
created	string	Required within parent	The date and time when the domain was created. Format: date-time
domain	string	Required within parent	The actual domain or sub-domain. e.g. www.hubspot.com
id	string	Required within parent	The unique ID of this domain.
isResolving	boolean	Required within parent	Whether the DNS for this domain is optimally configured for use with HubSpot.
isSslEnabled	boolean	Required within parent	Indicates whether SSL is enabled for the domain.
isSslOnly	boolean	Required within parent	Indicates whether the domain is accessible only via SSL.
isUsedForBlogPost	boolean	Required within parent	Whether the domain is used for CMS blog posts.
isUsedForEmail	boolean	Required within parent	Whether the domain is used for CMS email web pages.
isUsedForKnowledge	boolean	Required within parent	Whether the domain is used for CMS knowledge pages.
isUsedForLandingPage	boolean	Required within parent	Whether the domain is used for CMS landing pages.
isUsedForSitePage	boolean	Required within parent	Whether the domain is used for CMS site pages.
manuallyMarkedAsResolving	boolean	Required within parent	Indicates whether the domain has been manually marked as resolving.
primaryBlogPost	boolean	Required within parent	Indicates whether the domain is the primary domain for blog posts.
primaryEmail	boolean	Required within parent	Indicates whether the domain is the primary domain for email pages.
primaryKnowledge	boolean	Required within parent	Indicates whether the domain is the primary domain for knowledge pages.
primaryLandingPage	boolean	Required within parent	Indicates whether the domain is the primary domain for landing pages.
primarySitePage	boolean	Required within parent	Indicates whether the domain is the primary domain for site pages.
secondaryToDomain	string	Required within parent	Specifies the domain to which this domain is secondary.
updated	string	Required within parent	The date and time when the domain was last updated. Format: date-time

Policy, approvals and errors

SDK function policy ID: hubspot.domains_get_domain. Catalog operation: domains_get_domain. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["cms.domains.read", "cms.domains.write", "cms.knowledge_base.settings.read", "cms.knowledge_base.settings.write", "content"]

Official provider source