GET
/
cms
/
v3
/
domains
/
Get current domains
curl --request GET \
  --url https://api.hubapi.com/cms/v3/domains/ \
  --header 'Authorization: Bearer <token>'
{
  "total": 2,
  "results": [
    {
      "id": "1234",
      "createdAt": "2017-07-24T17:24:09.141Z",
      "updatedAt": "2017-07-25T18:20:00.000Z",
      "domain": "234.hs-sites.com",
      "isPrimaryLandingPage": false,
      "isPrimaryEmail": false,
      "isPrimaryBlogPost": true,
      "isPrimarySitePage": false,
      "isPrimaryKnowledge": false,
      "isResolving": true,
      "isManuallyMarkedAsResolving": false,
      "isHttpsEnabled": true,
      "isHttpsOnly": false,
      "isUsedForBlogPost": true,
      "isUsedForSitePage": false,
      "isUsedForLandingPage": false,
      "isUsedForEmail": false,
      "isUsedForKnowledge": false,
      "expectedCname": "234.group34.sites.hubspot.net",
      "redirectTo": ""
    },
    {
      "id": "4321",
      "createdAt": "2017-07-11T13:00:52.928Z",
      "updatedAt": "2019-10-08T16:54:57.165Z",
      "domain": "test.demo.com",
      "isPrimaryLandingPage": false,
      "isPrimaryEmail": false,
      "isPrimaryBlogPost": true,
      "isPrimarySitePage": false,
      "isPrimaryKnowledge": false,
      "isResolving": true,
      "isManuallyMarkedAsResolving": false,
      "isHttpsEnabled": true,
      "isHttpsOnly": false,
      "isUsedForBlogPost": true,
      "isUsedForSitePage": false,
      "isUsedForLandingPage": false,
      "isUsedForEmail": false,
      "isUsedForKnowledge": false,
      "expectedCname": "234.group34.sites.hubspot.net",
      "redirectTo": ""
    }
  ]
}
Supported products
Requires one of the following products or higher.
Marketing HubMarketing HubProfessional
Sales HubSales HubFree
Service HubService HubFree
Content HubContent HubStarter

​
Required Scopes

This API requires one of the following scopes:
  • cms.domains.read
  • content
  • cms.domains.write
  • cms.knowledge_base.settings.write
  • cms.knowledge_base.settings.read

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
createdAt
string<date-time>

Only return domains created at this date.

​
createdAfter
string<date-time>

Only return domains created after this date.

​
createdBefore
string<date-time>

Only return domains created before this date.

​
updatedAt
string<date-time>

Only return domains updated at this date.

​
updatedAfter
string<date-time>

Only return domains updated after this date.

​
updatedBefore
string<date-time>

Only return domains updated before this date.

​
sort
string[]
​
after
string

The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results.

​
limit
integer

Maximum number of results per page.

​
archived
boolean

Whether to return only results that have been archived.

Response

200
application/json

successful operation

The response is of type object.