Objects and attributes

Attributes of the objects passed to templates.

organization

Field	Description
name	organization name
legal_name	legal name
domain	site subdomain
currency	currency (e.g. EUR)
contact_email	contact email
sender_email	sender email
contact_phone	contact phone
city	city
state	province
postal_code	postal code
country	country
vat	VAT number
tax_identification_number	tax code
privacy_policy	privacy policy
tos	terms of service
logo	logo
base_site_url	site base URL
base_site_fqdn	full site domain
is_development	true in development environment

campaign

Field	Description
id	identifier
title	title
content	content (HTML)
cover	cover image (URL)
slug	slug in the URL
seo_title	SEO title
seo_description	SEO description
url	campaign URL
allow_peer_to_peer	peer-to-peer fundraising enabled
is_lead	Lead-type campaign
is_goal_enabled	goal active
goal	goal amount
goal_percentage	percentage reached
total_donated	total raised
total_donations	number of donations
total_supporters	number of supporters
required_fields	required checkout fields
shown_fields	fields shown in the checkout
cost_examples	cost examples (see below)
public_donations	public donations (see below)
customfields	custom fields (see Custom fields)
comments	list of comments (see below)
peer_campaigns	linked peer-to-peer fundraisers

<h1>{{ campaign.title }}</h1>
{{ campaign.total_donated | format_money }} raised out of {{ campaign.goal | format_money }}
{% for donation in campaign.public_donations %}
  {{ donation.supporter.full_name }} - {{ donation.amount | format_money }}
{% endfor %}

campaign.cost_examples

Field	Description
uuid	identifier
amount	amount
name	name
description	description
image	image (URL)
monitor_quantity	tracks available quantity
quantity	total quantity
available_quantity	available quantity

campaign.comments

Field	Description
message	comment text
create_date	creation date
supporter_name	supporter name
supporter_image	supporter image
donation_amount	donated amount
anonymous	anonymous comment

peer_campaign

Field	Description
id	identifier
title	fundraiser title
supporter_image	promoter image; if the fundraiser has none, the supporter's
supporter_name	promoter name
slug	slug in the URL
custom_message	custom message
goal	fundraising goal
is_goal_enabled	goal active
goal_percentage	percentage of the goal reached
supporter	promoter supporter
url	fundraiser URL
update_url_v2	URL of the edit view v2, under the campaign (campaigns/<slug>/<peer_slug>/update/v2/)
manage_url	URL of the detail page inside the supporter area (/my/campaigns/<id>/): where the theme links point
campaign	linked campaign
stats	statistics (amount, total_donations, total_supporters)
total_donated	total raised by this fundraiser (same as stats.amount)
total_donations	number of donations of this fundraiser
total_supporters	number of supporters of this fundraiser
public_donations	public donations of this fundraiser (same shape as campaign.public_donations)
comments	messages left on this fundraiser (same shape as campaign.comments)

The last five fields have the same names as the campaign ones: a peer page can read the figures from a single object, as in the example below.

comments is a generator, as in campaign: to know whether there are messages, convert it once with |list instead of testing it directly.

{% set donations_source = peer_campaign or campaign %}
{{ donations_source.total_donated | format_money }} raised
{% for donation in donations_source.public_donations %}
  {{ donation.supporter.full_name }} - {{ donation.amount | format_money }}
{% endfor %}

page / blog / article

Field	Description
id	identifier
title	title
content	content (HTML)
cover	cover image (URL)
slug	slug in the URL
seo_title	SEO title
seo_description	SEO description
create_date	creation date
update_date	update date

In addition blog has articles (its articles) and article has blog (the blog it belongs to).

project

Field	Description
id	identifier
title	title
content	content (HTML)
cover	cover image (URL)
slug	slug in the URL
seo_title	SEO title
seo_description	SEO description
campaigns	project campaigns

supporter / donation

supporter:

Field	Description
id	supporter id
first_name	first name
last_name	last name
full_name	full name
email	email
phone	phone
address	address
city	city
locality	locality
postal_code	postal code
country	country
ssn	tax code
image	image (URL)
email_marketing	email consent
phone_marketing	phone consent
sms_marketing	SMS consent
postal_marketing	mail consent

donation:

Field	Description
id	donation id
amount	amount
supporter	supporter
campaign_title	campaign title
create_date	donation date
message	message
public	public donation

menu / menu item

menu:

Field	Description
name	menu name
handle	menu handle
menu_items	menu items

Menu item:

Field	Description
label	label
link	destination
type	type (homepage/page/blog/campaign/project/external)

The URL of an item is resolved with the {% nav %} tag (see Tags and filters).