This is the parent template

> ## Documentation Index > Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt > Use this file to discover all available pages before exploring further. --- id: 4bb1ebaa-0206-43f5-acc7-0cade00df1b0 --- # HubL functions > A reference listing of all of the available HubL functions. export const RequiredIndicator = () => { return required ; }; Functions in HubL are similar to filters in that they accept parameters and generate a value. However, not all functions need to be applied to an initial template value, and instead they interact with other areas of your HubSpot environment. If you maintain an older website, you may also want to check out the [list of deprecated HubL functions](/cms/versions-deprecations/deprecated/hubl/filters-functions). Below, learn more about each HubL function and its syntax. ## append Adds a single item to the end of a list. ```jinja theme={null} {% set numbers_under_5 = [1,2,3] %} {% do numbers_under_5.append(4) %} {{numbers_under_5}} ``` ``` [1, 2, 3, 4] ``` | Parameter | Type | Description | | --------- | ---- | -------------------------------- | | `item` | Any | Item to be appended to the list. | ## blog\_all\_posts\_url The `blog_all_posts_url` function returns a full URL to the listing page for all blog posts for the specified blog. The example below shows how this function can be used as an anchor's `href`. ```html theme={null} All Marketing blog posts ``` ``` All Marketing blog posts ``` | Parameter | Type | Description | | --------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | `selected_blog` | Blog ID or "default" | Specifies which blog to use. The blog id is returned by the [module blog field](/cms/reference/fields/module-theme-fields#blog). | ## blog\_author\_url The `blog_author_url` function returns a full URL to the specified blog author's listing page. The example below shows how this function can be used as an anchor's `href`. This can be combined with `blog_authors` as shown in that function's examples. ```jinja theme={null} Brian Halligan ``` ``` Brian Halligan ``` | Parameter | Type | Description | | --------------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `selected_blog` | Blog ID or "default" | Specifies which blog the author's listing page exists in. You can specify a blog by ID or use `"default"` to select the default blog. The blog ID is returned by the [module blog field](/cms/reference/fields/module-theme-fields#blog). | | `author_slug` | String or HubL Var | Specifies which author to link to. Can use either `content.blog_post_author.slug` or a lowercase hyphenated name. Example: `"jane-doe"`. | ## blog\_authors The `blog_authors` function returns a sequence of blog author objects for the specified blog, sorted by slug ascending. This sequence can be stored in a variable and iterated through to create custom author post filters. The number of live posts by each author can be accessed with `author.live_posts`. **Please note:** This function has a limit of 250 authors. This function also has a limit of 10 calls per page and per email. The first line of the example below shows how the function returns a sequence of author objects. The rest of the example shows a use case of saving a sequence into a variable and then iterating though the author objects, printing a set of author listing links. The example assumes that the blog has 4 authors. ```html theme={null} {{ blog_authors("default", 250) }} {% set my_authors = blog_authors("default", 250) %}

{{ author }}

``` ``` [ Tim Cramblin, Sam Duvet, Sheila Portnadi, Rhonda Devereux]

{{my_blog.html_title}}

``` ```

Outdoor biking for the earnest

``` | Parameter | Type | Description | | --------------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `selected_blog` | Blog ID or "default" | Specifies which blog to use, either a specific blog by its ID or the default blog by `"default"`. The blog ID is returned by the [module blog field](/cms/reference/fields/module-theme-fields#blog). | ## blog\_page\_link The `blog_page_link` function generates the URL of a paginated view of your blog listing. The function takes a numeric parameter, which allows you to generate links for current, next, previous, or a specific page. This function is generally used in the `href` attribute of pagination anchor tags and must be used on your blog listing template. The examples below show this function in use as an anchor `href`. The first example outputs the current page. The second example takes the number 7 parameter to specify the seventh page. The third example uses the `next_page_num` variable to generate a link that is relative to the current page number (you can also use the `last_page_num` variable for the previous page). The final example uses the `current_page_num` variable and a `+` operator to create a link that is 4 greater than the current page. ```html theme={null} Current page Page 7 Next Page Plus 4 ``` ``` Page 1 Page 7 Next Page Plus 4 ``` | Parameter | Type | Description | | --------- | ----------------------- | ------------------------------------------------------------------ | | `page` | Number or HubL variable | Page number used to generate URL or HubL variable for page number. | ## blog\_popular\_posts This function renders a set number of popular posts into a sequence. The sequence can then be saved into a variable and iterated through with a for loop, creating a custom post listing of your most popular posts. Results from this function are cached for six hours. To retrieve blog posts using HubL in a way that avoids caching, you may want to use [blog\_recent\_tag\_posts](#blog-recent-tag-posts) instead. In the example code below, the first line shows how the function returns a sequence. The sequence is saved as a variable which is then used in a [for loop](/cms/reference/hubl/loops). [Any blog post variables](/cms/reference/hubl/variables#blog-variables) should use the name of the individual loop item rather than `content.`. In the example, `pop_post.name` is used. This technique can be used on blog templates and website pages. **Please note:** This function has a limit of 200 posts. This function also has a limit of 10 calls per page and per email. ```jinja theme={null} {% set pop_posts = blog_popular_posts("default", 5, ["marketing-tips", "sales-tips"], "popular_past_month", "AND") %} {% for pop_post in pop_posts %}

{% endfor %} ``` ```html theme={null} [Popular post title 1, Popular post title 2, Popular post title 3, Popular post title 4, Popular post title 5]

Recent post title 5

{% endfor %} ``` ``` [Post about Marketing 1, Post about Marketing 2, Post about Marketing 3, Post about Marketing 4, Post about Marketing 5]

Post about Marketing

Post about Fun

Post about Inbound

``` | Parameter | Type | Description | | ------------------ | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `selected_blog` | Blog ID or "default" | Specifies which blog to use, either a specific blog by its ID or the default blog by `"default"`. The blog ID is returned by the [module blog field](/cms/reference/fields/module-theme-fields#blog). | | `tag_slug` | String | Specifies which tag to filter on. You can include up to 10 tags, comma separated. Tags with multiple words must be lowercase with spaces replaced by hyphens. | | `limit` | Integer | Specifies the number of posts to add to the sequence. This parameter is required when including a `logical_operator`. | | `logical_operator` | String | When `tag_slug` contains multiple tags, use this operator to filter results with `AND` or `OR` logic. By default, this function uses `OR` logic to return posts tagged with any of the specified tags.When including this parameter, `limit` is required. | ## blog\_tag\_url The `blog_tag_url` function returns a full URL to the specified blog tag's listing page. This function accepts two parameters. The first parameter specifies which blog the tag's listing page exists in. The second parameter specifies which tag to link. This parameter can use the **`topic.slug`** for a particular tag from `content.topic_list` or accepts a lowercase hyphenated name such as `"marketing-tips"`. The example below shows how this function can be used as an anchor's href. ```jinja theme={null} Inbound Marketing ``` ``` Inbound Marketing ``` | Parameter | Type | Description | | --------------- | -------------------- | ------------------------------------------------------------------------------------------------- | | `selected_blog` | Blog ID or "default" | Specifies which blog to use, either a specific blog by its ID or the default blog by `"default"`. | | `tag_slug` | String | Specifies which tag to link to. | ## blog\_tags The `blog_tags` function returns a sequence of the 250 most blogged-about tags (based on number of associated blog posts) for the specified blog, sorted by blog post count.This sequence can be stored in a variable and iterated through to create custom tag post filters. The number of posts for each tag can be accessed with `tag.live_posts`. This function accepts two parameters. The first parameter specifies which blog to fetch tags from. The second parameter sets a limit on the number of tags fetched. The first line of the example below demonstrates how the function returns a sequence of tag objects. The rest of the example demonstrates a use case of saving a sequence into a variable and then iterating though the tag objects, printing a set of tag links. The example assumes that the blog has 4 tags. **Please note:** This function has a limit of 250 tags. ```jinja theme={null} {{ blog_tags("default", 250) }} {% set my_tags = blog_tags("default", 250) %}

{{ item }}

``` ``` [ Blogging, Inbound Marketing, SEO, Social Media]

``` | Parameter | Type | Description | | --------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | `selected_blog` | Blog ID or "default" | Specifies which blog to use. The blog ID is returned by the [module blog field](/cms/reference/fields/module-theme-fields#blog). | | `limit` | Integer | The maximum amount of tags to return. | ## blog\_total\_post\_count This function returns the total number of published posts in the specified blog. If no parameter is specified, it will count your default blog posts. Alternatively, you can specify `"default"` or a blog ID of a different blog to count. The blog ID is available in the URL of your blog dashboard for a particular blog. **Please note:** This function has a limit of 10 calls per page and per email. ``` {{ blog_total_post_count }} {{ blog_total_post_count(359485112) }} ``` ``` 16 54 ``` | Parameter | Type | Description | | --------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `selected_blog` | Blog ID or "default" | Specifies which blog to count. The blog ID is returned by the [module blog field](/cms/reference/fields/module-theme-fields#blog). | ## clear Removes all items from a list. Unlike `pop()`, it does not return anything. ```jinja theme={null} {% set words = ["phone","home"] %} {% do words.clear() %} {{words}} ``` ``` [] ``` ## color\_contrast This function validates color contrast based on [WCAG standards](https://www.w3.org/WAI/WCAG21/Understanding/contrast-minimum). You'll need to include two colors as arguments, and you can include an optional argument to specify the rating (`AA` or `AAA`). Returns `true` or `false` based on whether the colors meet/exceed the standard. ```jinja theme={null} {{color_contrast('#FFFFFF','#273749')}} {{color_contrast('rgb(255, 255, 255)','rgb(229, 237, 245)','AAA')}}

Hey there

``` ``` true false Hey there ``` | Parameter | Type | Description | | --------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `color_1` | Color | The first color to compare. Accepts:

6-digit hex codes (`#FFFFFF`)
3-digit hex codes (`#F0A`)
RGB color codes (`rgb(12,31,1)`)

Can also use a variable that stores a hex or RGB color code. For example:`theme.primary_color.color` | | `color_2` | Color | The second color to compare against the first. | | `rating` | String | The WCAG standard to use for rating. Can be either `AA` (default) or `AAA`. | ## color\_variant This function lightens or darkens a hex value or color variable by a set amount. The first parameter is the hex color (for example ("#FFDDFF") or a variable storing a hex value. The second parameter is the amount to adjust it by, from 0 to 255. This function can be used in CSS files to create a color variation. Another good use case is to use it with a color parameter of a color module, to allow users to specify a primary color that automatically generates a color variation. In the example below, the hex color #3A539B is stored in a variable called `base_color`. The color is modified by -80 resulting in a darker blue (#00034B). ```jinja theme={null} {% set base_color ="#3A539B" %} {{ color_variant(base_color, -80) }} ``` ``` #00034b ``` | Parameter | Type | Description | | ------------------- | ---------------- | ----------------------------------------------------------------------- | | `base_color` | HEX color string | The starting color to be altered. For example, `#F7F7F7`. | | `brightness_offset` | Integer | A positive or negative number used to lighten or darken the base color. | ## content\_by\_id Returns a landing page, website page or blog post by ID. The only parameter accepted by this function is a numeric content ID. The below example code shows this function in use to generate a hyperlinked list item. **Please note:** This function has a limit of 10 calls per page and 20 calls per email. ```jinja theme={null} {% set my_content = content_by_id(4715624297) %}

{{my_content.title}}

``` ```

How do I create default values for my email or smart content personalization tokens?

``` | Parameter | Type | Description | | --------- | ---- | --------------------------------- | | `id` | ID | The ID of the content to look up. | ## content\_by\_ids Given a list of content IDs, returns a dict of landing page, website page or blog posts matching those IDs. This function takes one parameter, a list of page or blog post IDs to look up, placed within an array. Up to 100 content objects can be passed. The below example code shows this function in use to generate a list of hyperlinked list items. **Please note:** This function has a limit of 10 calls per page and per email. ```jinja theme={null} {% set contents = content_by_ids([4715624297, 4712623297, 5215624284]) %}

{{content.title}}

``` ```

``` | Parameter | Type | Description | | --------- | ---- | ------------------------------------------------------------------------------------ | | `ids` | List | A list of page or blog post IDs to look up. Up to 100 content objects can be passed. | ## copy Return a shallow copy of the list. Equivalent to `a[:]`. A *shallow copy* constructs a new compound object and then (to the extent possible) inserts *references* into it to the objects found in the original. ```jinja theme={null} {% set a = ["ham"] %} {% set b = a.copy() %} a: {{a}} b: {{b}} After Append {% do a.append("swiss") %} a: {{a}} b: {{b}} ``` ``` a: [ham] b: [ham] After Append a: [ham, swiss] b: [ham] ``` ## count Returns the number of times a variable exists in a list. ```jinja theme={null} {% set attendees = ["Jack","Jon","Jerry","Jessica"] %} {% set jon_count = attendees.count("Jon") %} There are {{jon_count}} Jon's in the list.

After append:

{% do attendees.append("Jon") %} {% set jon_count_after_append = attendees.count("Jon") %} There are now {{jon_count_after_append}} Jon's in the list. ``` ``` There are 1 Jon's in the list.

After append:

There are now 2 Jon's in the list. ``` ## crm\_associations Gets a list of CRM records associated with another record by its record ID, association category, and association definition ID. **Please note:** * For security purposes, of the [HubSpot standard object types](https://knowledge.hubspot.com/get-started/manage-your-crm-database#standard-objects) only the `product`, and `marketing_event` objects can be retrieved on a publicly accessible page. Any other standard object type must be hosted on a page which is either [password protected](https://knowledge.hubspot.com/website-pages/password-protect-a-page) or requires a [membership login](https://knowledge.hubspot.com/website-pages/require-member-registration-to-access-private-content). Custom objects do not have this same restriction. * This function can be called a maximum of 10 times per page and per email. Each `crm_associations` call can return at most 100 objects. The default limit is 10 objects. ```jinja wrap theme={null} {% set associated_contacts = crm_associations(847943847, "HUBSPOT_DEFINED", 2, "limit=3&years_at_company__gt=2&orderBy=email", "firstname,email", false) %} {{ associated_contacts }} ``` | Property | Type | Description | | ---------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | ID | ID of the record to find associations from. | | `association category` | String | The category of the association definition. Possible values are `HUBSPOT_DEFINED`, `USER_DEFINED`, and `INTEGRATOR_DEFINED`. This parameter can be omitted for hubspot defined built-in association types. | | `association type id` | Integer | The ID of the association definition to use. For standard HubSpot supported objects see [ID of the association type to use](/api-reference/latest/crm/associations/associate-records/guide).Otherwise, this association ID can found at the [CRM Objects Schema API](/cms/start-building/features/data-driven-content/crm-objects#getting-a-custom-object-type-s-details). | | `query` | String | The `id` of the record OR a query string, delimited by `&`. All expressions are ANDed together. Supported operators are:

`eq` (default)
`neq`
`lt`
`lte`
`gt`
`gte`
`is_null`
`not_null`
`in`
`nin`
`contains` (applicable for multi-valued properties or string properties, e.g., *"firstname\_\_contains=Tim"*)

Queries can include the following parameters:

`limit`: the maximum number of results returned in the response. For example, `limit=50`.
`offset`: for paging through the results if the number of returned results is higher than the limit parameter. For example, `offset=51`.
`orderBy`: order results by a specific property. For example, `orderBy=email`.

| | `properties` | String | Optional. A comma-separated list of properties to return. By default, a small set of common properties are returned. The ID property is always returned.A full list of properties can be found using the [get all contact properties](/api-reference/legacy/crm/properties/v1/company-properties/get-properties-v1-companies-properties) and [get all company properties](/api-reference/legacy/crm/pipelines/get-pipelines) endpoints. | | `formatting` | Boolean | Optional. Format values such as dates and currency according to the account's settings. Omit or pass `false` for raw strings. | ```jinja wrap theme={null} {has_more=true, offset=3, total=203, results=[{firstname=Aimee, id=905, email=abanks@company.com}, {firstname=Amy, id=1056, email=abroma@company.com}, {firstname=Abigael, id=957, email=adonahu@company.com}]} ``` | Property | Type | Description | | ---------- | ------- | ------------------------------------------------------------------------------ | | `has_more` | Boolean | Indicates there are more results available beyond this batch (total > offset). | | `total` | Integer | The total number of results available. | | `offset` | Integer | The offset to use for the next batch of results. | | `results` | Array | The associated objects matching the function's parameters. | ## crm\_object Gets a single CRM record by query or by its ID. Records are returned as a dict of properties and values. This function can also be [used with custom and integrator objects](/cms/start-building/features/data-driven-content/crm-objects). **Please note:** * For security purposes, of the [HubSpot standard object types](https://knowledge.hubspot.com/get-started/manage-your-crm-database#standard-objects) only the `product`, and `marketing_event` objects can be retrieved on a publicly accessible page. Any other standard object type must be hosted on a page which is either [password protected](https://knowledge.hubspot.com/website-pages/password-protect-a-page) or requires a [membership login](https://knowledge.hubspot.com/website-pages/require-member-registration-to-access-private-content). Custom objects do not have this same restriction. * This function can only be called a maximum of 10 times on a single page. ```jinja theme={null} {% set contact = crm_object("contact", "email=contact@company.com", "firstname,lastname", false) %} {% set contact = crm_object("contact", 123) %} {{ contact.firstname }} {{ contact.lastname }} ``` ``` Brian Halligan ``` | Parameter | Type | Description | | ------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `object_type` | String | The object type name. Object type names are case sensitive. [The supported object types](/cms/start-building/features/data-driven-content/crm-objects#supported-crm-object-types). To find the names of the account specific and integrator object types available in your account use the [CRM Objects Schema API](/cms/start-building/features/data-driven-content/crm-objects#getting-a-custom-object-type-s-details) to get the type definitions and look for the name property. It contains the internal object type name that should be used in the function. For integrator and account specific object types with the same name as the built-in objects use the objects [fully qualified name](/cms/start-building/features/data-driven-content/crm-objects#getting-a-custom-object-type-s-details) (FQN). | | `query` | String | Optional. The `id` of the record OR a query string, delimited by `&`. All expressions are ANDed together. Supported operators are:

`eq` (default)
`neq`
`lt`
`lte`
`gt`
`gte`
`is_null`
`not_null`
`in`
`nin`
`contains` (applicable for multi-valued properties or string properties, e.g., `"firstname__contains=Tim"`).

Queries can include the following parameters:

`limit`: the maximum number of results returned in the response. For example, `limit=50`.
`offset`: for paging through the results if the number of returned results is higher than the limit parameter. For example, `offset=51`.
`orderBy`: order results by a specific property. For example, `orderBy=email`.

| | `properties` | String | Optional. A comma-separated list of properties to return. By default, a small set of common properties are returned. The ID property is always returned.A full list of properties can be found using the [get all contact properties](/api-reference/legacy/crm/properties/v1/company-properties/get-properties-v1-companies-properties) and [get all company properties](/api-reference/legacy/crm/pipelines/get-pipelines) endpoints. | | `formatting` | Boolean | Optional. Format values such as dates and currency according to the account's settings. Pass `false` for raw strings. | **Please note:** When building a query, the values of `range`, `distinct`, `ndistinct`, and `startswith` are reserved keywords. To query a property that uses one of those names, you'll need to use the following format: `range__eq=` (rather than `range=`). ## crm\_objects Gets a list of records for a specific object type from the HubSpot CRM. **Please note:** * For security purposes, of the [HubSpot standard object types](https://knowledge.hubspot.com/get-started/manage-your-crm-database#standard-objects) only the `product`, and `marketing_event` objects can be retrieved on a publicly accessible page. Any other standard object type must be hosted on a page which is either [password protected](https://knowledge.hubspot.com/website-pages/password-protect-a-page) or requires a [membership login](https://knowledge.hubspot.com/website-pages/require-member-registration-to-access-private-content). Custom objects do not have this same restriction. * This function can be called a maximum of 10 times per page and per email. Each `crm_objects` call can return at most 100 objects. The default limit is 10 objects. Results can be sorted using at least one order parameter in the query. For example, `crm_objects("contact", "firstname=Bob&order=lastname&order=createdate")` will order contacts with the first name `"Bob"` by last name and then by `createdate`. To reverse a sort, prepend `-` to the property name (e.g., `order=-createdate`). The CRM objects function can also be [used with custom and integrator objects](/cms/start-building/features/data-driven-content/crm-objects). ```jinja wrap theme={null} {% set objects = crm_objects("contact", "firstname__not_null=&limit=3", "firstname,lastname") %} {{ objects }} ``` | Parameter | Type | Description | | ----------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `object_type` | String | The object type name (case-sensitive). See [supported object types](/cms/start-building/features/data-driven-content/crm-objects#supported-crm-object-types). For custom objects, you'll need to use the Fully Qualified Name (FQN), which can be found using the [Schemas API](/api-reference/latest/crm/objects/schemas/get-schemas). | | `query` | String | The ID of the record or a query string, delimited by `&`. All expressions are ANDed together. Supported operators are:

`eq` (default)
`neq`
`lt`
`lte`
`gt`
`gte`
`is_null`
`not_null`
`in`
`nin`
`contains` (applicable for multi-valued properties or string properties, e.g., `"firstname__contains=Tim"`).

Example: `"email=contact@company.com"` | | `properties` | String | A comma-separated list of properties to return. By default, a small set of common properties are returned. You can retrieve all properties for an object using the [Properties API](/api-reference/latest/crm/properties/guide). | | `formatting` | Boolean | Format values such as dates and currency according to the account's settings. Pass `false` for raw strings. | ```jinja wrap theme={null} {has_more=true, offset=3, total=331, results=[{firstname=Brian, id=44151, lastname=Halligan}, {firstname=Dharmesh, id=44051, lastname=Shah}, {firstname=George, id=88551, lastname=Washington}]} ``` | Property | Type | Description | | ---------- | ------- | ------------------------------------------------------------------------------------------------------------- | | `has_more` | Boolean | Indicates there are more results available beyond this batch (total > offset). | | `total` | Integer | The total number of results available. | | `offset` | Integer | The offset to use for the next batch of results. | | `results` | Array | The associated objects matching the function's parameters. See results properties below for more information. | **Please note:** When building a query, the values of `range`, `distinct`, `ndistinct`, and `startswith` are reserved keywords. To query a property that uses one of those names, you'll need to use the following format: `range__eq=` (rather than `range=`). ## crm\_property\_definition Get the property definition for a given object type and property name. Supported object types are HubSpot standard objects (e.g., contacts), account-specific objects, and integrator objects. ```jinja theme={null} {% set prop = crm_property_definition("contact", "firstname") %} {{ prop.label }} {{ prop.type }} ``` ``` First name string ``` | Parameter | Type | Description | | --------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `object_type` | String | The object type name (case-sensitive). See [supported object types](/cms/start-building/features/data-driven-content/crm-objects#supported-crm-object-types). For custom objects, you'll need to use the Fully Qualified Name (FQN), which can be found using the [Schemas API](/api-reference/latest/crm/objects/schemas/get-schemas). | | `property_name` | String | The case-insensitive property name to retrieve the definition for. | ## crm\_property\_definitions Get the property definitions for a given object type and set of property names. Supported object types are HubSpot standard objects (e.g. contacts), account-specific objects, and integrator objects. ```jinja theme={null} {% set props = crm_property_definitions("contact", "firstname,lastname") %} {{ props.firstname.label }} {{ props.lastname.label }} ``` ``` First name Last name ``` | Parameter | Type | Description | | --------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `object_type` | String | The object type name (case-sensitive). See [supported object types](/cms/start-building/features/data-driven-content/crm-objects#supported-crm-object-types). For custom objects, you'll need to use the Fully Qualified Name (FQN), which can be found using the [Schemas API](/api-reference/latest/crm/objects/schemas/get-schemas). | | `property_name` | String | Optional. The case-insensitive property names comma separated, to retrieve the definition for. If empty, the definitions for all the properties will be retrieved. | ## cta Because CTA modules have so many parameters that contain variations of their code, you can use the CTA function to easily generate a particular CTA in a template, page, or email. This function is what the rich text editor uses when you add a CTA via the editor. **Please note:** This function has a limit of 10 calls per page and per email. ```jinja theme={null} {{ cta("ccd39b7c-ae18-4c4e-98ee-547069bfbc5b") }} {{ cta("ccd39b7c-ae18-4c4e-98ee-547069bfbc5b", "justifycenter") }} ``` ```html theme={null} Start a HubSpot trial Start a HubSpot trial ``` | Parameter | Type | Description | | ----------- | ----------- | ------------------------------------------------------------------------------------------------------- | | `guid` | String | The ID of the CTA to render. Can be found in the URL of the details screen of the CTA. | | `align_opt` | Enumeration | Adjusts alignment of CTA. Values include `justifyleft`, `justifycenter`, `justifyright`, `justifyfull`. | ## extend Extend a list by appending all items from an iterable. In other words, insert all list items from one list into another list. ```jinja theme={null} {% set vehicles = ["boat","car","bicycle"] %} {% set more_vehicles = ["airplane","motorcycle"] %} {% do vehicles.extend(more_vehicles) %} {{vehicles}} ``` ```html theme={null} [boat, car, bicycle, airplane, motorcycle] ``` ## file\_by\_id This function returns the metadata of a file by ID. It accepts a single parameter, the numeric ID of the file to look up. To retrieve multiple files at once, use the [files\_by\_ids](#files_by_ids) function instead. **Please note:** This function is limited to 10 calls per page and per email. ```jinja theme={null} {% set file = file_by_id(123) %} {{ file.friendlyUrl }} ``` ```html theme={null} https://www.hubspot.com/hubfs/HubSpot_Logos/HSLogo_color.svg ``` | Parameter | Type | Description | | --------- | ------ | ------------------------------ | | `file_id` | Number | The ID of the file to look up. | ## files\_by\_ids Returns the metadata of multiple files by ID. It accepts an array of file IDs. **Please note:** This function limited to 10 calls per page and per email, and can accept up to 100 file IDs. ```jinja theme={null} {% set files = files_by_ids([123,456])%} {% for file in files %} URL:{{file.friendlyUrl}}
{% endfor %} ``` ```html theme={null} URL:https://api-na1.hubspot.com/filemanager/api/v2/files/123/example-file-1 URL:https://api-na1.hubspot.com/filemanager/api/v2/files/456/example-file-2 ``` | Parameter | Type | Description | | --------- | ------ | ----------------------------------------------------------------- | | `file_id` | Number | The IDs of the files to look up, separated by commas (up to 100). | For example, you can use this function, to loop through a contact's uploaded files. To loop through results, you'll need to use the [split HubL filter](/cms/reference/hubl/filters#split), as the CRM property will be returned as a semicolon-separated string. ```jinja theme={null} {% set objects = crm_objects("contact", "email=bh@hubspot.com", "file").results %} {% for item in objects %} {% set fileIDs = item.file|split(";") %} {% set files = files_by_ids(fileIDs) %} {% for file in files %}

File name: {{file.name}}
Friendly Url: {{file.friendlyUrl }}
Url: {{file.url }}

{% endfor %} {% endfor %} ``` ## flag\_content\_for\_access\_check When a blog post is [configured for self-registration access](https://knowledge.hubspot.com/blog/use-self-registration-for-private-blog-content), visitors will need to register or log in to view the full post content. HubSpot's default blog listing assets automatically include this functionality, and will also include a lock icon indicator for posts that require self-registration to access. Learn more about [building custom solutions using this function and its corresponding API](/cms/start-building/features/memberships/overview#private-blog-posts-with-self-registration). This function checks whether a blog post can be accessed by the current visitor. When called, the function is replaced with the following attribute: `hs-member-content-access=` A value of `true` indicates that the blog post requires the visitor to log in to view the full content. ```jinja theme={null} {% for content in contents %}

...

{% endfor %} ``` ```html theme={null}

...

``` | Parameter | Type | Description | | --------- | ---- | -------------------------------------------------------------------------------- | | `ID` | ID | The ID of the content that will be checked against the current logged in viewer. | ## follow\_me\_links Returns the [social media account links set in account settings](https://knowledge.hubspot.com/design-manager/use-default-modules-in-the-layout-editor#add-social-accounts-to-the-follow-me-module). Used in the [default follow\_me module](/cms/reference/modules/default-modules#follow-me). ```jinja theme={null} {% set fm = follow_me_links() %} {{ fm }} ``` ```html theme={null} [FollowMeLink{type=URL, id=5142734, altName=RSS, followMeUrl=http://website.com/rss.xml, iconName=rss, name=http://website.com/rss.xml}] ``` ## format\_address Formats an address based on the context's locale. ```jinja theme={null} {{ format_address('en-us', { address: "25 First Street", address2: "2nd Floor", city: "Cambridge", state: "MA", country: "United States", zip: "02141"}) }} ``` ``` [25 First Street, 2nd Floor, Cambridge, MA 02141, United States] ``` | Parameter | Type | Description | | ---------- | ------ | ------------------------------------------------------------------ | | `locale` | String | The locale to format the address in. | | `address` | String | The street address. | | `address2` | String | The second line of the address, such as floor or apartment number. | | `city` | String | The city of the address. | | `state` | String | The state of the address. | | `country` | String | The country of the address. | | `zip` | String | The zip code of the address. | ## format\_company\_name Formats a company's name by adding Japanese honorifics where appropriate. ```jinja theme={null} {{ format_company_name("companyName", addJapaneseHonorifics) }} ``` ``` HubSpot ``` | Parameter | Type | Description | | -------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------ | | `companyName` | String | The name of the company. | | `useHonorificIfApplicable` | Boolean | When set to `true` and the context's language is Japanese, a Japanese company honorific will be added where appropriate. | ## format\_name Formats a person's name by putting the surname before the first name and adds Japanese honorifics where appropriate ```jinja theme={null} {{ format_name("firstName", "surname", addJapaneseHonorifics) }} ``` ``` Hobbes Baron ``` | Parameter | Type | Description | | -------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `firstName` | String | The person's first name. | | `surname` | String | The person's surname or last name. | | `useHonorificIfApplicable` | Boolean | When set to `true` and the context's language is Japanese, a Japanese honorific will be added where appropriate. Default is `false`. | ## format\_datetime Formats both the date and time components of a date object, similar to the [format\_datetime](/cms/reference/hubl/filters#format_datetime) HubL filter. This function replaces the deprecated `datetimeformat` function. ```jinja theme={null} {{ format_datetime(content.publish_date, "short", "America/New_York", "en") }} ``` ``` 12/31/69 7:00 PM ``` | Parameter | Type | Description | | ---------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `format` | String | The format to use. Can be one of:

`short`
`medium`
`long`
`full`
a custom pattern following [Unicode LDML](https://unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns)

| | `timeZone` | String | The time zone of the output date in [IANA TZDB format](https://data.iana.org/time-zones/tzdb/). | | `locale` | String | The locale to use for locale-aware formats. | ## geo\_distance This function contains 4 parameters and calculates the ellipsoidal 2D distance between two points on Earth. Use this function as a filter query for getting HubDB data. ```jinja theme={null} {% for row in hubdb_table_rows(1234567, "geo_distance(loc,1.233,-5.678,mi)__gt=500") %} {{row.name}}
{% endfor %} ``` ``` Cambridge, MA
Salem, MA
San Diego, CA
Chicago, IL
``` | Parameter | Type | Description | | ------------- | --------- | ------------------------------------------------------------------------------------------------------------- | | `point1` | Location | location from a HubDB column. | | `point2_lat` | Latitude | Latitude of point2. | | `point2_long` | Longitude | Longitude of point2. | | `units` | String | Units for the return value. Options are `FT` for feet, `MI` for miles, `M` for meters or `KM` for kilometers. | ## get\_asset\_url This function returns the public URL of a specified template or code file. The parameter of this function is the asset's path in the design manager. Coded file URLs update each time you publish them; therefore, by using this function your ensure you are always using the latest version of the file. You can automatically generate this function in the app, by either right-clicking a **file** and selecting **Copy public URL**, or by clicking **Actions**, then selecting **Copy public URL**. The example below gets the URL of a Javascript file authored in Design Manager that can be included as the `src` of a ` ``` If your page domain was `website.com`, the associated API endpoint would be: ``` https://website.com/_hcms/personalization?contactProperties=a,b&companyProperties=c,d&sig=AbCdEfG567890hIjK ``` You can then make a `GET` request to this endpoint, which would return a response that resembles the following: ```json theme={null} { "user": { "contact": { "a": "A value", "b": "B value" }, "company": { "c": "C value", "d": "D value" } }, "request": { "clientIp": "12.34.56.78", "country": "US", "deviceType": "desktop" } } ``` If the website visitor is known, the API will return the requested contact or company properties (excluding any properties marked as [Sensitive](https://knowledge.hubspot.com/account-security/store-sensitive-data)). Anonymous data such as user IP, device type, and language are always returned, and does not require a signature. ## require\_js Specifies whether a script should be enqueued to render in the head or footer (default). Specify the render location by including the `head` or `footer` parameter. The HubL will be replaced by an empty line, and included in either *the [header or footer includes](/cms/start-building/building-blocks/templates/html-hubl-templates#header-and-footer-includes).* To enqueue an inline script to be rendered in the footer via a `script` element, wrap your ` ``` ## resize\_image\_url Rewrites the URL of image stored in File Manager to a URL that will resize the image on request. The function accepts one required parameter, and five optional parameters. At least one optional parameter must be passed. **Please note:** Images that are larger than 4096 pixels in height or width will not be automatically resized. Instead, you'll need to [manually resize the image](https://knowledge.hubspot.com/files/automatic-image-resizing-on-hubspot-content). ```jinja theme={null} {{ resize_image_url("http://your.hubspot.site/hubfs/img.jpg", 0, 0, 300) }} ``` ``` http://your.hubspot.site/hubfs/img.jpg?length=300&name=img.jpg ``` | Parameter | Type | Description | | --------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------ | | `url` | String | URL of a HubSpot-hosted image. | | `width` | Integer (px) | The new image width, in pixels. | | `height` | Integer (px) | The new image height, in pixels. | | `length` | Integer (px) | The new length of the largest side, in pixels. | | `upscale` | Boolean | Use the resized image dimensions even if they would scale up the original image (images may appear blurry).Default value is `false`. | | `upsize` | Boolean | Return the resized image even if it is larger than the original in bytes.Default value is `false`. | ## reverse Reverses the order of items in a list. Doesn't take any parameters. To reverse an object or return an iterator to iterate over the list in reverse, use [`|reverse`](/cms/reference/hubl/filters#reverse) ```jinja theme={null} {% set numbers = [1,2,3,4] %} {% do numbers.reverse() %} {{numbers}} ``` ``` [4, 3, 2, 1] ``` ## super This function prints content from the parent template into a child template using the [extends](/cms/reference/hubl/overview#blocks-and-extends) tag. For example, in the code below, a basic HTML template has been created with a HubL block named `sidebar` and saved as `parent.html`. A second template file is created that will extend that parent file. Normally, the `

` would be printed in the parent HTML's sidebar block. But by using `super`, content from the parent template sidebar block is combined with the content from the child template. ```html theme={null} {% extends "custom/page/web_page_basic/parent.html" %} {% block sidebar %}
Table Of Contents
{{ super() }} {% endblock %} ``` ``` This is the parent template
Table of contents
Sidebar content from parent. ``` ## today Returns the start of today (12:00am). Optionally you can add a parameter to change the timezone from the default UTC. ```jinja theme={null} {{ today() }} {{ today("America/New_York") }} {{ unixtimestamp(today("America/New_York").plusDays(1)) }} ``` ``` 2018-10-23T00:00Z 2018-10-23T00:00-04:00[America/New_York] 1540353600000 ``` ## to\_local\_time Converts a UNIX timestamp to the local time, based on your HubSpot Report Settings. You can then apply a datetimeformat filter to format the date. ```jinja theme={null} {{ to_local_time(eastern_dt) }} ``` ``` 2015-05-13 10:37:31 ``` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------- | | `date` | Datetime | UNIX timestamp to convert to local time. | ## topic\_cluster\_by\_content\_id Returns a HubL dict representing the topic cluster associated with a piece of content (determined by the passed content id), including metadata about the associated pillar page, core topic, and subtopics. Can be used to "auto-link" a piece of content with its associated pillar page \[if it exists]. Available metadata can be found in: attachableContent (the current content's metadata), topic (the current content's associated topic metadata), coreTopic (the associated cluster's core topic metadata), and pillarPage (the associated pillar page's metadata). Use `{{ topicCluster|pprint }}` to see a full a display of available properties/attributes. ```jinja theme={null} {{ topic_cluster_by_content_id(content.id) }} {%- if content.id -%} {%- set topicCluster = topic_cluster_by_content_id(content.id) -%} {%- if topicCluster.pillarPage.url.value and topicCluster.pillarPage.publishState == "PUBLISHED" -%}
Topic: {{ topicCluster.coreTopic.phrase }}
{%- endif -%} {%- endif -%} ``` ``` { attachedContent, topic, coreTopic, pillarPage } (AttachedContentWithContext: {attachedContent=AttachedContent{id=1234, topicId=1234, clusterId=1234, portalId=0, attachable=Attachable{contentId=124, url=ValidatedUri{https://www.hubspot.com/}, attachableType=LANDING_PAGE, title=title, publishState=PUBLISHED, deletedAt=null}, isLinkedToPillarPage=null, isPillarPage=null, createdAt=1547238986475, updatedAt=1547238986475, deletedAt=null}, coreTopic=Optional[Topic{id=1234, portalId=0, clusterId=1234, phrase=TOPIC PHRASE, attachedContent=null, isCoreTopic=false, createdAt=1547157062081, updatedAt=1547232313421, deletedAt=null}], pillarPage=Optional[AttachedContent{id=1234, topicId=1234, clusterId=1234, portalId=0, attachable=Attachable{contentId=null, url=ValidatedUri{https://www.hubspot.com.com/}, attachableType=EXTERNAL_URL, title=null, publishState=PUBLISHED, deletedAt=null}, isLinkedToPillarPage=null, isPillarPage=null, createdAt=1547157062086, updatedAt=1547157062086, deletedAt=null}], topic=Optional[Topic{id=1234, portalId=0, clusterId=8345, phrase=topic phrase, attachedContent=null, isCoreTopic=false, createdAt=1547238962703, updatedAt=1547238962703, deletedAt=null}]})
Topic: core topic phrase
``` Please note: This function has a limit of 10 calls per page and per email. | Parameter | Type | Description | | ------------ | ---- | ------------------------------ | | `content_id` | Id | The id of the page to look up. | ## truncate The truncate function works just like the [truncate filter](/cms/reference/hubl/filters#truncate), but uses function syntax instead of filter syntax. The first parameter specifies the string. The second parameter specifies the length at which to truncate. The final parameter specifies the characters to add when the truncation occurs. Please note: Because this function relies on the spaces between words to shorten strings, it may not work as expected for languages without spaces between characters, such as Japanese. ```jinja theme={null} {{ truncate("string to truncate at a certain length", 19, false, "...") }} {% set longString = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus sodales ultricies velit sit amet ornare." %} {{ truncate(longString, 40, false, "...") }} ``` ``` string to truncate ... Lorem ipsum dolor sit amet, consectetur ... ``` | Parameter | Type | Description | | -------------------- | ------- | ------------------------------------------------------------------------------------------- | | `string_to_truncate` | String | String that will be truncated. | | `length` | integer | Specifies the length at which to truncate the text (includes HTML characters). | | `killwords` | boolean | If true, the string will cut text at length, regardless of if it's in the middle of a word. | | `end` | String | The characters that will be added to indicate where the text was truncated. | ## type This function accepts one argument and returns the type of an object. The return value is one of: `"bool"`, `"datetime"`, `"dict"`, `"float"`, `"int"`, `"list"`, `"long"`, `"null"`, `"str"` or `"tuple"`. ```jinja theme={null} {{ type("Blog") }} {% set my_type = type("Blog") %}
{{my_type}}
``` ```
str
``` ## unixtimestamp This function returns a unix timestamp when you supply a datetime object. ```jinja theme={null} {{ unixtimestamp(d) }} ``` ``` 1565983117868 ``` ## update Updates the dict with the elements from another dict object or from an iterable of key-value pairs. Use this function to combine or merge objects. ```jinja theme={null} {% set dict_var = {"authorName": "Douglas Judy", "authorTitle": "Mastermind" } %} {% do dict_var.update({"authorFriend": "Jake"}) %} {% do dict_var.update({"authorLocation": "unknown"}) %} {{ dict_var }} ``` ``` {authorName=Douglas Judy, authorTitle=Mastermind, authorFriend=Jake, authorLocation=unknown} ```