Use CRM object data in CMS Hub

Last updated:

You can query CRM objects to use data from the object's records on HubSpot hosted content, allowing data to be shared between your business operations, website, and emails. Using the crm_object, crm_objects and crm_associations HubL functions, you can display and control logic based on your CRM object data. 

Using CRM data on your website means that your sales, marketing, and website data all live in the same place and will always reflect the same information. In addition, because you can associate CRM records with one another, you can also pull in associated data onto your website pages.

Similarly, you can create sets of dynamic pages that automatically generate using CRM object or HubDB data.

Example use case

One example of using CRM object data in pages is a real estate listing page. With a custom object called property, individual object records can be created for each house that needs to be listed. Real estate agents can then add information to object properties to store details, such as location, number of bedrooms, and asking prices. 

Website pages can then pull in that record data for each property to create a listing page and details pages for each property. 

Check out the GitHub repo to view the full example.

For an overview of this example, check out the recording of HubSpot Developer Day 2020

Supported CRM object types

Below are the types of CRM objects that you can pull data from for your CMS Hub pages. Whether you can use the data across all pages or only on private pages depends on the object type.

In the tables below, learn about which object types are available for CMS content along with their object type names and fully qualified names. 

Please note: standard object names, such as "contact," are not case sensitive, but must be singular.

CRM object data available for all pages

Data from the following CRM objects can be used on any CMS page.

Object type object_type name Fully qualified name
Products product PRODUCT
Marketing events marketing_event MARKETING_EVENT
Custom objects

CMS Hub Enterprise only.

You can either use the object's fully qualified name, or the name that was entered at the time of creation. For example, if you create an object named "Cars," you cannot reference it with "cars" or Car."

You must use the fully qualified name if the custom object shares a name with a standard object.

 

CRM object data available for private pages

Data from the following CRM objects can be used only on pages that require either a password or a membership login.

Object type object_type name  FULLY QUALIFIED NAME
Contacts contact CONTACT
Companies company COMPANY
Deals deal DEAL
Tickets ticket TICKET
Quotes quote QUOTE
Integrator objects

To get an integrator object's name, use the CRM objects schema API.

For integrator objects with the same name as the standard objects, use the integrator object's fully qualified name.

 

Display data from a single CRM record with the crm_object function

Use the crm_object function to get a single record from the HubSpot CRM by query or by CRM record ID. 

Object records are returned as a dict of properties and values.

{# Render custom object by query #} {% set event = crm_object("event", "name=Defensive Health") %} {{ event.name }} {# Render custom objects specifying the id of the object #} {% set event = crm_object("event", 289236) %} {{ event.name }} <p>Defensive Heatlh</p> <p>Defensive Heatlh</p>

If a query returns a collection of records, the function will return the first record in the collection.

Display data from multiple CRM records with the crm_objects function

Use the crm_objects() function to get CRM records by object type from the HubSpot CRM by query or by record ID. Records are returned as a dict of properties and values.

The record returned contains a results property that can be looped through to display the information in the record's items.

{# Render custom objects by query #} {% set events = crm_objects("event", "limit=3&type=virtual") %} <h3>{{events.total}} New Events:<h3> <ul> {% for event in events.results %} <li>Name: {{ event.name }}</li> {% endfor %} <ul> {# Render custom objects by ids #} {% set events = crm_objects("event", [289236,289237,289238]) %} <h3>{{events.total}} New Events:<h3> <ul> {% for event in events.results %} <li>Name: {{ event.name }}</li> {% endfor %} <ul> <h3>3 New Events:<h3> <ul> <li>Name: Defensive Health</li> <li>Name: Body Balance</li> <li>Name: Happy Heart</li> <ul> <h3>3 New Events:<h3> <ul> <li>Name: Defensive Health</li> <li>Name: Body Balance</li> <li>Name: Happy Heart</li> <ul>

Display associated records

Use the crm_associations HubL function to get a list of associated records from the HubSpot CRM based on the given record ID, association category, and association definition ID.

Records are returned as a dict of properties and values.

{% set associated_objects = crm_associations(289236, "USER_DEFINED", 3) %} <h3>Contacts Associated With Event</h3> <ul> {% for contact in associated_objects.results %} <li>Name: {{ contact.firstname }} {{ contact.lastname }}</li> {% endfor %} </ul> <h3>Contacts Associated With Event<h3> <ul> <li>Name: Brian Halligan</li> <li>Name: Dharmesh Shah</li> <li>Name: Yamini Rangan</li>

Getting a custom object type's details

To get a custom object type's name, id, fullyQualifiedName, association IDs, and other details, you can make a GET request to the CRM Objects schema API.

Please note: fullyQualifiedName for account-specific object types includes the HubSpot account ID, so it's recommended to avoid using it when developing your code for multiple HubSpot accounts.

CRM Object Module field

To provide a way for content creators to select CRM records to display or execute logic, you can build modules that include the CRM object field.

For example, you may want to display information from a specific product, contact, company, deal, quote, ticket, or custom object.

CRM Object Field

Was this article helpful? *
This form is used for documentation feedback only. Learn how to get help with HubSpot...