There's a new version of the HubSpot API

Check out the new API

As of November 30, 2022, HubSpot API Keys are being deprecated and are no longer supported. Continued use of HubSpot API Keys is a security risk to your account and data. Your API Keys could be deactivated at any time after Nov. 30th, and we recommend that you migrate to Private Apps as soon as possible so you do not lose business-critical functionality.

List domains

Last updated June 17, 2020

GET /cos-domains/v1/domains

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Get the domains set up in HubSpot. Supports paging and filtering.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.		 Used to authenticate the request. Please see this page for more details about authentication.

Optional query string filters & options

If a parameter supports a filter type of 'gt', that means you can append a double underscore to the parameter name to find all items greater than the value. For example, the following query will find all items created than the 'updated' time:
Parameter name Description
limit The number of items to return. Defaults to 20
offset The offset set to start returning rows from. Defaults to 0.
created exact, range, gt, gte, lt, lte
domain exact
id exact
is_resolving exact
primary_site_page exact

Example GET URL: https://api.hubapi.com/cos-domains/v1/domains?hapikey=demo

JSON Fields returned in the response

Parameter name Type Description
created long When the domain was first created, in milliseconds since the epoch
domain string The actual domain or subdomain
id string The unique id of the domain
is_any_primary string True if this domain is primary for any category
is_dns_correct string True if DNS for this domain is optimally configured for use with HubSpot
is_legacy_domain string True is this domain is setup for use with the classic CMS
is_resolving string True if this domain is pointing to HubSpot servers
manually_marked_as_resolving string True if a user manually marked this domain as resolving. This is needed when their is some unique setup or proxy server involved, and the COS can not automatically detect if the domain is properly resolving
primary_blog_post string True if this domain is primary for COS blog posts
primary_email string True if this domain is primary for viewing emails as web page
primary_landing_page string True if this domain is primary for COS landing pages
primary_legacy_page string True if this domain is primary for the classic CMS
primary_site_page string True if this domain is primary for COS site pages
secondary_to_domain string The name of the domain that this domain redirects to. Only set for non-primary domains
updated long When the domain was last updated, in milliseconds since the epoch

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example URL: https://api.hubapi.com/cos-domains/v1/domains?hapikey=demo { "total_count": 4, "objects": [ { "actual_cname": "", "actual_ip": "", "consecutive_non_resolving_count": 0, "created": 1333053295000, "domain": "mattschnitt.hs-sites.com", "full_category_key": null, "id": 104095, "is_any_primary": false, "is_dns_correct": true, "is_internal_domain": true, "is_legacy": false, "is_legacy_domain": false, "is_resolving": true, "manually_marked_as_resolving": false, "portal_id": 77572, "primary_blog_post": false, "primary_email": false, "primary_landing_page": false, "primary_legacy_page": false, "primary_site_page": false, "secondary_to_domain": "www.mattschnitt.com", "updated": 1400868969000 }, { "actual_cname": "", "actual_ip": "", "consecutive_non_resolving_count": 0, "created": 1358568517000, "domain": "mattschnitt.app7.hubspot.com", "full_category_key": "1:legacy_page", "id": 16905181, "is_any_primary": false, "is_dns_correct": true, "is_internal_domain": true, "is_legacy": true, "is_legacy_domain": true, "is_resolving": true, "manually_marked_as_resolving": false, "portal_id": 77572, "primary_blog_post": false, "primary_email": false, "primary_landing_page": false, "primary_legacy_page": false, "primary_site_page": false, "secondary_to_domain": "", "updated": 1401846605000 }, { "actual_cname": "", "actual_ip": "", "consecutive_non_resolving_count": 0, "created": 1358580092000, "domain": "mattschnitt.web7.hubspot.com", "full_category_key": "1:legacy_page", "id": 17200586, "is_any_primary": true, "is_dns_correct": true, "is_internal_domain": true, "is_legacy": true, "is_legacy_domain": true, "is_resolving": true, "manually_marked_as_resolving": false, "portal_id": 77572, "primary_blog_post": false, "primary_email": false, "primary_landing_page": false, "primary_legacy_page": true, "primary_site_page": false, "secondary_to_domain": "", "updated": 1401846596000 }, { "actual_cname": "", "actual_ip": "", "consecutive_non_resolving_count": 0, "created": 1399071692000, "domain": "www.mattschnitt.com", "full_category_key": null, "id": 722611752, "is_any_primary": true, "is_dns_correct": true, "is_internal_domain": false, "is_legacy": false, "is_legacy_domain": false, "is_resolving": true, "manually_marked_as_resolving": true, "portal_id": 77572, "primary_blog_post": true, "primary_email": true, "primary_landing_page": true, "primary_legacy_page": false, "primary_site_page": true, "secondary_to_domain": "", "updated": 1400868969000 } ], "limit": 20, "offset": 0 }