Liquid Objects

Liquid Objects, a coding term that is also known as liquid variables, contain attributes to output dynamic content on a page.

For example, the Account liquid object contains an attribute called Name that can be used to output the name of your organization.

To output an Object’s Attribute on the page, wrap them in {{ and }}, as shown below:

{{ account.name }}

Attributes can be a single value like {{ account.name }} or a collection of other objects like {{ link.links }}.

Using Custom Fields with objects:

You can access an Object’s Custom Fields setup in REACH using the liquid code below wherever liquid is used such as Email Templates, Mail Merge Templates and in Themes (layouts, templates, and partials).

You will need to indicate the Object (supporter, sponsorship, project, place, or campaign) followed by the permalink of the custom field. 

{{ supporter | custom_field: ‘gender’ }}

Below is a list of all available Liquid Objects. Click on each one to be taken to its section that lists its corresponding attributes.

Account

example call: {{ account.name }}

active_campaigns_goal
active_campaigns_total
active_notices
active_places
active_projects
address
admin_domain
approved_campaigns
available_campaign_themes
available_random_sponsorships
available_sponsorships
a_color
body_bg_color
body_bg_image
body_bg_image_file
body_bg_style
body_font_family
body_text_color
button_color
button_hover_color
button_text_color
button_text_hover_color
call_to_action_bg
call_to_action_btn_type
call_to_action_button_text
call_to_action_color
call_to_action_link
call_to_action_text
campaigns
campaigns_banner
campaigns_hero_file
campaign_name
campaign_overview
city
css_styling
currency_symbol
dba_name
email
facebook_pixel
family_sponsorships
family_sponsorships_for_select
founded
google_analytics
group_sponsorships_for_select
gstw_logo_file
gstw_overview
header_bg_color
header_text_color
home_hero_file
h_color
logo_file
logo_file_original
message_bg_color
name
organization_ein
overview
permalink
phone
phone
places
places_banner
places_hero_file
place_name
place_overview
postal
primary_domain
projects
projects_banner
projects_hero_file
project_name
project_overview
public_sponsorship_types
sponsorships
sponsorships_banner
sponsorships_hero_file
sponsorship_categories_for_select
sponsorship_message
sponsorship_name
sponsorship_overview
sponsorship_share_name
sponsorship_types
state
sub_project_name
supporter_campaign_name
tag_line
text_to_give_number
toolbar_a_color
toolbar_bg_color
toolbar_h1_color
upcoming_events
use_campaign_banner
use_place_banner
use_project_banner
use_sponsorship_banner
website
wrapper_bg_color

Address

example call: {{ address.account }}

account
address1
address2
address_type
city
country
notes
postal
primary
state
supporter

Admin

example call: {{ admin.email }}

email
first_name
last_name
name

Album

example call: {{ album.title }}

campaign
date
description
full_url
permalink
photos
place
project
sponsorship
title
type
url

Campaign Theme

example call: {{ campaign_theme.id }}

campaign_cover_image_editable
campaign_description
campaign_description_editable
campaign_description_editable
campaign_goal_amount
campaign_goal_amount_editable
campaign_goal_end_date
campaign_goal_end_date_editable
campaign_image_editable
campaign_short_description
campaign_short_description
campaign_short_description_editable
campaign_title
campaign_title_editable
campaign_title_prompt
campaign_video_link
campaign_video_link_editable
cover_image_content_type
cover_image_file_name
cover_image_file_size
cover_image_prompt
cover_image_updated_at
description_prompt
description_prompt
goal_amount_prompt
goal_end_date_prompt
id
image_content_type
image_file_name
image_file_size
image_prompt
image_updated_at
live
parsed_campaign_description
parsed_campaign_short_description
parsed_campaign_short_description
parsed_campaign_title
parsed_theme_description
parsed_theme_title
permalink
set_campaign_title
set_cover_image
set_description
set_description
set_goal_amount
set_goal_end_date
set_image
set_short_description
set_video_link
short_description_prompt
theme_description
theme_title
video_link_prompt

Campaign

example call: {{ campaign.title }}

account
albums
approved
approved_children
complete_donations
complete_donations_and_pledges
cover_images
custom_field_values
days_remaining
description
donation_levels
donors
donors_including_pledges
embedded_video
full_url
funded?
gifts
goal_amount
goal_end_date
images
long_description
messages
messages_and_albums
owner
parent
permalink
pledges
products
sanitized_description
short_description
sponsorship
sponsorship_categorizations
text_code
title
total
total_with_pledges
url
video_link

Cart Line Item

example call: {{ cart_line_item.price }}

base_currency
base_deductible_amount
base_total_amount
base_total_price
base_transaction_fees
id
price
product
purpose
purpose_image
purpose_url
quantity
recurring
recurring_period
referral
referral_type
share_type
taxable
total_price
total_shipping_cost

Cart

example call: {{ cart.id }}

cart_line_items
id
size
sub_total
total_price
total_shipping_cost

Category

example call {{ category.permalink }}

account
full_url
messages
permalink
title
url

Contact Method

example call {{ contact_method.primary }}

account
contact_type
country_code
country_format
extension
object_type
pretty_type
primary
supporter
to_s
value

Contribution Statement

example call: {{ contribution_statement.statementid }}

account
admin
end_date
export_url
start_date
statement_id
status
supporter

Conversation Message

example call: {{ conversation_message.body }}

account
admin_read_at
body
conversation
creator
uploads
user_read_at
written_at

Conversation

example call: {{ conversation.subject }}

account
archive
category
conversation_messages
created_at
messages
referral
subject
updated_at
user
user_url

Domain

example call: {{ domain.hostname }}

hostname

Donation Level

example call: {{ donation_level.amount }}

amount
donate_link
title

Donation

example call: {{ donation.total_amount }}

address1
address2
amount
anonymous_amount
anonymous_donor
base_amount
base_currency
base_currency_symbol
base_deductible_amount
base_gift_aid_amount
base_total_amount
base_transaction_fees
cart
check_number
check_number
city
confirmation
country
currency
currency_symbol
date
deductible_amount
donations_given_to_pledge
email
exchange_rate
first_name
funded_pledge?
gift_aid_amount
honoree_email
honoree_name
honoree_note
id
is_campaign?
is_product?
last_name
line_items
name
note
payment_type
phone
phone
pledge_description
pledge_status
postal
pretty_type
purpose
recurring
recurring_period
reference_number
referral
referral_title
referral_type
shipping_address1
shipping_address2
shipping_city
shipping_country
shipping_postal
shipping_state
state
supporter
taxable
total_amount
total_pledges_received
transaction_fees

Event Ticket

example call: {{ event_ticket.quantity_left }}

admin_only
deposit_taxable_price
deposit_tax_deductible_price
description
id
maximum_per_order
minimum_per_order
price
quantity
quantity_left
sales_end_at
sales_start_at
taxable_price
tax_deductible_price
title

Event

example call: {{ event.venue_name }}

custom_fields
dates
description
end_at
event_tickets
full_url
gifts
images
image_file_name
permalink
start_at
title
url
venue_address1
venue_address2
venue_city
venue_country
venue_name
venue_postal
venue_state

Group

example call: {{ group.description }}

account
description
fundraiser
title

Link

example call: {{ link.title }}

links
login_required
title
url

Menu

example call: {{ menu.top_level_links }}

links
permalink
title
top_level_links

Message

example call: {{ message.body }}

author
body
categories
embedded_video
full_url
media
permalink
publish_at
title
type
uploads
url
video
video_link

Notice

example call: {{ notice.html_content }}

alert_class
content
end_date
html_content
start_date

Page – example call: {{ page.full_url }}

body
full_url
permalink
status
title
url

Photo

example call: {{ photo.original }}

description
file_name
large
medium
original
small
thumbnail

Place

example call: {{ place.description }}

account
albums
approved_campaigns
campaigns
cover_images
custom_field_values
description
donation_levels
full_url
gifts
goal_amount
images
latitude
leader
leader_email
leader_phone
location
longitude
permalink
projects
sanitized_description
sponsorships
sponsorship_categorizations
subtitle
text_code
title
total
url
web_address

Product Variant

example call: {{ product_variant.price }}

barcode
description
id
images
image_file_name
inventory
number_sold
permalink
price
shippable
shipping_cost
sku
sold_out?
taxable
title

Product

example call: {{ product.product_variants }}

barcode
description
id
images
image_file_name
inventory
number_sold
owner
permalink
price
product_variants
sanitized_description
shippable
shipping_cost
sku
sold_out?
sponsorship_gift
taxable
title
url

Project

example call: {{ project.sponsorships }}

account
albums
approved_campaigns
campaigns
cover_images
custom_field_values
description
donation_levels
full_url
gifts
goal_amount
images
leader
leader_email
leader_phone
parent
permalink
places
sanitized_description
sponsorships
sponsorship_categorizations
subtitle
sub_projects
text_code
title
total
url
web_address

Share Type

example call: {{ share_type.sponsorships }}

active_sponsorship_shares
available_sponsorship_shares
cost_per_share
disabled_sponsorship_shares
graduated_sponsorship_shares
hidden_sponsorship_shares
permalink
shares
shares_sponsored
sponsorsed_sponsorship_shares
sponsorships
title
total_sponsorship_shares

Sponsorship Categorization

example call: {{ sponsorship_categorization.title }}

categorization
data_type
full_url
permalink
referral
select_title
serialized_value
sponsorship
title
url
value

Sponsorship Category

example call: {{ sponsorship_category.permalink }}

form_validations
permalink

Sponsorship Supporter

example call: {{ sponsorship_supporter.past_due_amount }}

cancelled_at
created_at
donation_frequency
next_donation
past_due?
past_due_amount
payment_coming_due?
payment_credit_amount
payment_upcoming_amount
shares
share_type
sponsorship
sponsorship.title
supporter
total_amount_without_fees
total_given_with_skipped
total_needed
total_payment_amount

Sponsorship Type

example call: {{ sponsorship_type.description }}

active_sponsorships
allow_campaigns
allow_one_time_donations
available_random_sponsorships
available_sponsorships
available_sponsorship_shares
cost_per_month
cost_per_share
description
description
disabled_sponsorships
full_url
graduated_sponsorships
hidden
hidden_sponsorships
include_bi_annual_option
include_quarterly_option
include_yearly_option
permalink
recurring_period
shares
share_types
sponsorships
title
total_sponsorship_shares
url

Sponsorship

example call: {{ sponsorship.sponsorship_supporters }}

account
age
album
all_shares
biggest_need
children
current_shares
date_of_birth
days_waiting
descendants
description
disable
external_reference_id
full_url
gender
gifts
goal_amount
group
hidden
images
messages
monthly_need
parent
permalink
place
position
project
public_files
root
sanitized_description
shares_available
shares_for_select
shares_sponsored
siblings
sponsored_shares
sponsorship_categories
sponsorship_categorizations
sponsorship_supporters
sponsorship_type
sponsor_only_sponsorship_categories
title
total
total_shares
url

Supporter

example call: {{ supporter.current_sponsorship_supporters }}

account
address1
address2
all_donations
biannual_total_due
billing_address
city
country
current_sponsorship_supporters
email
email_message
first_name
home_phone
id
last_name
last_year_donation_amount
lifetime_donation_amount
mailing_address
major_sponsor
message
middle_name
mobile_phone
monthly_total_due
name
organization
other_email
permalink
personal_email
phone
postal
preferred_name
prefix
previous_email
primary_address
primary_email
primary_phone
quarterly_total_due
sponsorship_categorizations
sponsorship_supporters
state
suffix
total_num_shares
unread_message_count
url
work_email
work_phone
yearly_total_due
year_to_date_donation_amount

Theme Partial

example call: {{ theme_partial.name }}

name
theme

Theme Template

example call: {{ theme_template.name }}

name
theme

Theme

example call: {{ theme.title }}

title

Upload

example call: {{ upload.file_name }}

file_name
images
is_image?
url

Tags: , ,

Was this article helpful?

Previous Article

Theme Menu