Navigation: Catalog: Pages > Schemas > Schema: WebsitePages > Tables

SitePagesByObjectId

Retrieve a website pageRetrieve a website page by its ID.

Catalog: Pages

Schema: WebsitePages

This is a read-only table function. The HubSpot API may not support changing the data or the Invantive UniversalSQL driver for HubSpot does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the HubSpot API.

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function SitePagesByObjectId. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name	Required	Documentation
archived	☐	Whether to return only results that have been archived.
objectId	☑
property	☐

Columns of Table Function

The columns of the table function SitePagesByObjectId are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required	Documentation
abStatus	varchar2	A/B Status	☐	The status of the AB test associated with this page, if applicable
abTestId	varchar2	A/B Test ID	☐	The ID of the AB test associated with this page, if applicable
archivedAt	datetime	Archived at	☐	The timestamp (ISO8601 format) when this page was deleted.
archivedInDashboard	char	Archived in Dashboard	☐	If True, the page will not show up in your dashboard, although the page could still be live.
authorName	varchar2	Author Name	☐	The name of the user that updated this page.
campaign	varchar2	Campaign	☐	The GUID of the marketing campaign this page is a part of.
categoryId	int32	Category ID	☐	ID of the type of object this is. Should always .
contentGroupId	varchar2	Content Group ID	☐	The unique identifier for the content group associated with the page.
contentTypeCategory	varchar2	Content Type Category	☐	An ENUM descibing the type of this object. Should be either LANDING_PAGE or SITE_PAGE.
created	datetime	Created at	☐	The timestamp indicating when the page was created.
createdById	varchar2	Created by ID	☐	The ID of the user that created this page.
currentlyPublished	char	Currently Published	☐	Indicates whether the page is currently published.
currentState	varchar2	Current State	☐	A generated ENUM descibing the current state of this page.
domain	varchar2	Domain	☐	The domain this page will resolve to. If null, the page will default to the primary domain for this content type.
dynamicPageDataSourceId	varchar2	Dynamic Page Data Source ID	☐	The identifier for the data source used by the dynamic page.
dynamicPageDataSourceType	int32	Dynamic Page Data Source Type	☐	The type of data source used by the dynamic page.
dynamicPageHubDbTableId	varchar2		☐	The ID of the HubDB table this page references, if applicable
enableDomainStylesheets	char	Enable Domain Stylesheets	☐	Boolean to determine whether or not the styles from the template should be applied.
enableLayoutStylesheets	char	Enable Layout Stylesheets	☐	Boolean to determine whether or not the styles from the template should be applied.
featuredImage	varchar2	Featured Image	☐	The featuredImage of this page.
featuredImageAltText	varchar2	Featured Image Alternate Text	☐	Alt Text of the featuredImage.
folderId	varchar2	Folder ID	☐	The ID of the associated folder this landing page is organized under in the app dashboard.
footerHtml	varchar2	Footer (HTML)	☐	Custom HTML for embed codes, javascript that should be placed before the </body> tag of the page.
headHtml	varchar2	Head (HTML)	☐	Custom HTML for embed codes, javascript, etc. that goes in the <head> tag of the page.
htmlTitle	varchar2	Title (HTML)	☐	The html title of this page.
id	varchar2	ID	☐	The unique ID of the page.
includeDefaultCustomCss	char	Include Default Custom CSS	☐	Boolean to determine whether or not the Primary CSS Files should be applied.
language	varchar2	Language	☐	The explicitly defined ISO 639 language code of the page. If null, the page will default to the language of the Domain.
layoutSections	varchar2	Layout Sections	☐	A structure detailing the layout sections of the page.
linkRelCanonicalUrl	varchar2	Link Rel Canonical (URL)	☐	Optional override to set the URL to be used in the rel=canonical link tag on the page.
mabExperimentId	varchar2	MAB Experiment ID	☐	The ID of the MAB test (or dynamic test) associated with this page, if applicable
metaDescription	varchar2	Meta Description	☐	A description that goes in <meta> tag on the page.
name	varchar2	Name	☐	The internal name of the page.
pageExpiryDate	int64	Page Expiry Date	☐	The date at which this page should expire and begin redirecting to another url or page.
pageExpiryEnabled	char	Page Expiry Enabled	☐	Boolean describing if the page expiration feature is enabled for this page
pageExpiryRedirectId	int64	Page Expiry Redirect ID	☐	The ID of another page this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectUrl.
pageExpiryRedirectUrl	varchar2	Page Expiry Redirect (URL)	☐	The URL this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectId.
pageRedirected	char		☐	A generated Boolean describing whether or not this page is currently expired and being redirected.
password	varchar2	Password	☐	Set this to create a password protected page. Entering the password will be required to view the page.
publicAccessRulesEnabled	char	Public Access Rules Enabled	☐	Boolean to determine whether or not to respect publicAccessRules.
publishDate	datetime	Publish Date	☐	The date (ISO8601 format) the page is to be published at.
publishImmediately	char	Publish Immediately	☐	Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.
slug	varchar2	Slug	☐	The path of the this page. This field is appended to the domain to construct the url of this page.
state	varchar2(25)	State	☐	An ENUM descibing the current state of this page.
subcategory	varchar2	Subcategory	☐	Details the type of page this is. Should always be landing_page or site_page
templatePath	varchar2		☐	String detailing the path of the template used for this page.
themeSettingsValues	varchar2	Theme Setting Values	☐	A collection of settings specific to the theme applied to the page.
translatedFromId	varchar2	Translated from ID	☐	ID of the primary page this object was translated from.
translations	varchar2	Translations	☐	A map of translations for the page, each associated with a specific language variation.
updated	datetime	Updated at	☐	The timestamp indicating when the page was last updated.
updatedById	varchar2	Updated by ID	☐	The ID of the user that updated this page.
url	varchar2	URL	☐	A generated field representing the URL of this page.
useFeaturedImage	char	Use Featured Image	☐	Boolean to determine if this page should use a featuredImage.
widgetContainers	varchar2	Widget Containers	☐	A data structure containing the data for all the modules inside the containers for this page. This will only be populated if the page has widget containers.
widgets	varchar2	Widgets	☐	A data structure containing the data for all the modules for this page.

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

HubSpot API Data Model

SitePagesByObjectId

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information