HubSpot · Schema
CollectionResponsePage
A paginated list of CMS pages.
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales
Properties
| Name | Type | Description |
|---|---|---|
| results | array | |
| paging | object | Pagination information. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/cms-pages-api-collection-response-page-schema.json",
"title": "CollectionResponsePage",
"description": "A paginated list of CMS pages.",
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"description": "A HubSpot CMS page (site page or landing page).",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the page.",
"example": "500123"
},
"name": {
"type": "string",
"description": "The internal name of the page.",
"example": "Example Record"
},
"htmlTitle": {
"type": "string",
"description": "The HTML title tag content for the page.",
"example": "Example Record"
},
"slug": {
"type": "string",
"description": "The URL slug for the page.",
"example": "example-value"
},
"state": {
"type": "string",
"description": "The current publish state of the page.",
"enum": [
"DRAFT",
"PUBLISHED",
"ARCHIVED"
],
"example": "DRAFT"
},
"currentState": {
"type": "string",
"description": "The current display state of the page.",
"example": "active"
},
"contentTypeCategory": {
"type": "integer",
"description": "The content type category code.",
"example": 100
},
"publishDate": {
"type": "string",
"format": "date-time",
"description": "The date and time the page was or will be published.",
"example": "2025-03-15T14:30:00Z"
},
"metaDescription": {
"type": "string",
"description": "The meta description for SEO.",
"example": "This is an example description."
},
"url": {
"type": "string",
"description": "The full URL of the published page.",
"example": "https://app.hubspot.com/contacts/12345"
},
"domain": {
"type": "string",
"description": "The domain the page is hosted on.",
"example": "example.hubspot.com"
},
"language": {
"type": "string",
"description": "The language code for the page content.",
"example": "en"
},
"templatePath": {
"type": "string",
"description": "The path to the template used by the page.",
"example": "/content/templates/example"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "The date and time the page was created.",
"example": "2025-03-15T14:30:00Z"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "The date and time the page was last updated.",
"example": "2025-03-15T14:30:00Z"
},
"archived": {
"type": "boolean",
"description": "Whether the page has been archived.",
"example": true
}
}
},
"example": [
{
"id": "500123",
"name": "Example Record",
"htmlTitle": "Example Record",
"slug": "example-value",
"state": "DRAFT",
"currentState": "active",
"contentTypeCategory": 100,
"publishDate": "2025-03-15T14:30:00Z",
"metaDescription": "This is an example description.",
"url": "https://app.hubspot.com/contacts/12345",
"domain": "example.hubspot.com",
"language": "en",
"templatePath": "/content/templates/example",
"createdAt": "2025-03-15T14:30:00Z",
"updatedAt": "2025-03-15T14:30:00Z",
"archived": true
}
]
},
"paging": {
"type": "object",
"description": "Pagination information.",
"properties": {
"next": {
"type": "object",
"properties": {
"after": {
"type": "string"
}
},
"example": {
"after": "example-value"
}
}
}
}
}
}