HubSpot: Domains schemas

← Domains operations · All 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

List Domains — request body — query

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
after	string	Optional
archived	boolean	Optional
createdAfter	string	Optional	Format: date-time
createdAt	string	Optional	Format: date-time
createdBefore	string	Optional	Format: date-time
limit	integer	Optional	Format: int32
sort	array	Optional
sort[]	string	Each item
updatedAfter	string	Optional	Format: date-time
updatedAt	string	Optional	Format: date-time
updatedBefore	string	Optional	Format: date-time

List Domains — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List Domains — response body — paging
results	array	Required within parent	The results of the query.
results[]	Model	Each item	Expand Get a single domain — response body
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	The number of available results. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get a single domain — response body, List Domains — response body — paging

List Domains — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
next	Model	Optional	Expand List Domains — response body — paging next
prev	Model	Optional	Expand List Domains — response body — paging prev

Referenced models: List Domains — response body — paging next, List Domains — response body — paging prev

List Domains — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	The cursor value indicating where to begin fetching the next page of results in a paginated collection
link	string	Optional	An optional URL for directly accessing the next page of results.

List Domains — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	A string token used as a cursor to identify the position before the current set of results in pagination.
link	string	Optional	A string containing the URL link to the previous page of results.