Liquid API - Pages

<- Back to Liquid API

These variables are only available on their specific pages.

Site Landing PageLink

The site landing page has access to any of the global variables. When building a site landing page, please take a look at a working example in the basic theme folder "Site Pages/Site Landing Page"

Affiliate Index PageLink

descriptionThis is the page where an affiliate can view general affiliate information.
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.affiliate_commission_percentageGet the user's affiliate commission

Affiliate Links PageLink

descriptionThis is the page where an affiliate can view their product links.
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.homepage_link{String} Get the homepage affiliate's linkpage.affiliate_links{Hash} Get the affiliate's product linkspage.has_affiliate_links{Boolean} Does the affiliate have any product links? True or false

Affiliate Reports PageLink

descriptionThis is the page where an affiliate can view their affiliate data.
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.total_commission_owed_in_dollars{String} Get the user's total commission that is still owedpage.total_commission_paid_in_dollars{String} Get the user's total commission that has been paidpage.commissions{Drops::AffiliateCommission} Get the user's comissionspage.payouts{Drops::AffiliatePayout} Get the user's payoutspage.visitor_dates{Hash} Get the user's visitor datespage.has_commissions{Boolean} Does the user have any comission? True or Falsepage.has_payouts{Boolean} Does the user have any payout? True or Falsepage.has_visitors{Boolean} Has the user had any visitors? True or False

Affiliate Links PageLink

descriptionThis is the page where an affiliate can edit their affiliate settings.
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this page

Bundle PageLink

descriptionThis is the landing page for a bundle. It is used to supply data to any bundle landing page template that you create.
contextavailable UNKNOWN
locatordescriptionpage.page_identifierThe unique identifier for this pagepage.bundle{Drops::Bundle} Get bundle datapage.coupon{Drops::Coupon} Get coupon datapage.coupon_code_provided{Boolean} Has a coupon code been provided? True or falsepage.seo_title{String} Get the SEO Titlepage.seo_description{String} Get the SEO Descriptionpage.keywords{String} Get the product's keywordspage.is_hidden{Boolean} Is the product hidden? True or falsepage.product_is_course{Boolean} Is the product a course?page.product_is_bundle{Boolean} Is the product a bundle?page.landing_page_code{String} Get the custom landing page code

Checkout PageLink

descriptionThis is the page that the buyer is shown when making a purchase. Includes the Checkout sign in page and Checkout - payment page.
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.checkout_form{String} Get checkout form htmlpage.cart{Drops::Cart} The current cartpage.contains_subscription_product{Boolean} Does the checkout include a subscription product? True or falsepage.course_name{String} Get the course namepage.course_price{String} Get the course pricepage.has_subscription_products{Boolean} Does the course have subscription products? True or false. Duplicate of abovepage.stripe_checkout_is_allowed{Boolean} Is stripe checkout allowed? True or false.page.checkout_coupons_disabled{Boolean} Are coupons on checkout disabled? True or false.page.header_without_links_required{Boolean} Is a header without links required? Defaults to true.page.product{Drops::Product} The product being purchasedpage.product_price{Drops::ProductPrice} The product price being purchasedpage.checkout_description{String} The description of what is being purchased

Checkout Sign In/Sign Up PageLink

descriptionThis is the page that is displayed to an anonymous user as they enter the checkout flow
contextavailable UNKNOWN
locatordescriptionpage.page_identifierThe unique identifier for this pagepage.active_tabrubocop:disable Style/TrivialAccessorspage.cart{Drops::Cart} The current cartpage.product{Drops::Product} The product being purchasedpage.product_price{Drops::ProductPrice} The product prices of the product being purchasedpage.checkout_description{String} The description of what is being purchasedpage.checkout_coupons_disabled{Boolean} Are checkout coupons disabled? True or false.page.header_without_links_required{Boolean} Is a header without links required? True or false. Defaults to true.page.stripe_checkout_is_allowed{Boolean} Is stripe checkout allowed? True or false.page.has_remote_signin{Boolean} Does the user have a remote sign-in? True or falsepage.has_linkedin_enabled{Boolean} Does the user have LinkedIn enabled? True or falsepage.has_facebook_enabled{Boolean} Does the user have Facebook enabled? True or falsepage.has_google_enabled{Boolean} Does the user have Google enabled? True or falsepage.supports_remote_auth{Boolean} Supports remote auth? Always returns false. DEPRECATED (2018/08)page.linkedin_oauth_url{String} User LinkedIn oAuth Urlpage.facebook_oauth_url{String} User Facebook oAuth Urlpage.google_oauth_url{String} User Google oAuth Urlpage.tenant_oauth_url{String} Always returns '' (empty string). DEPRECATED (2018/08)page.tenant_auth_text{String} Always returns '' (empty string). DEPRECATED (2018/08)page.sign_up_url{String} Get the sign-in urlpage.forgot_password_url{String} Get the forgot password urlpage.sign_in_url{String} Get the sign-in urlpage.social_providers{Array} Get enabled social providers for the tenant with the following attributes: oauth_url, class and fa_icon

Checkout Thank-you PageLink

descriptionThis is the page that the buyer is shown after making a purchase
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.take_course_url{String} Get the take course url. DEPRECATEDpage.order_receipt_url{String} Get the order-receipt urlpage.order{Drops::Order} Get order detailpage.items{Drops::LineItem} Get a list of items that have been purchasedpage.course{Drops::Course} Get the checkout's course. Returs nil if purchased product is not a coursepage.bundle{Drops::Bundle} Get the checkout's bundle. Returs nil if purchased product is not a bundlepage.product_is_course{Boolean} Is the product a course? True or false.page.product_is_bundle{Boolean} Is the product a bundle? True or false.page.bundled_courses{Drops::Course} Get bundled coursespage.has_more_bundled_courses{Boolean} Does the purchased course have more bundled courses? True or falsepage.remaining_bundle_courses_message{String} Get the remaining bundle courses message

Collection PageLink

descriptionThis shows courses and bundles in a specific collection/category
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this page

Collections PageLink

descriptionThis page shows all the published courses
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.name{String} Get the name of the collectionpage.current_collection_id{Number} Get the seleceted collection idpage.current_collection_slug{String} get the slug of the collectionpage.current_collection_name{String} Get the name of the current collectionpage.should_paginate_products{Boolean} Should the collection be paginated? Returns true if the number of pages in the collection is greater than 1. True or false.page.product_page_numbers{Array} Get available page numbers for pagination of the collectionpage.current_product_page{Number} Get the current product's pagepage.has_products{Boolean} Does the collection have products? True or false.page.products{Drops::Product} Get the products to be rendered on the pagepage.has_search_query{Boolean} Does the page have a search query applied? True or false.page.search_query{String} Get the currently applied search query

Course Landing PageLink

descriptionThis is the landing page for a course. It is used to supply data to any course landing page template that you create.
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.course{Drops::Course} Get course datapage.coupon{Drops::Coupon} Get coupon datapage.coupon_code_provided{Boolean} Has a coupon code been provided? True or falsepage.thinkific_analytics_course_data{String} Get the thinkific analyitics course datapage.seo_title{String} Get the SEO Titlepage.seo_description{String} Get the SEO Descriptionpage.keywords{String} Get the product's keywordspage.is_hidden{Boolean} Is the product hidden? True or falsepage.product_is_course{Boolean} Is the product a course?page.product_is_bundle{Boolean} Is the product a bundle?page.landing_page_code{String} Get the custom landing page code

Custom PageLink

descriptionThese are the variables available on any custom page that you create
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.content{String} Get the content of the page (returns marked up html)page.name{String} Get the name of the pagepage.published{Boolean} Is the page published? True or falsepage.public{Boolean} Is the page public? True or falsepage.url{String} Get the url of the pagepage.seo_title{String} Get the page's SEO Titlepage.seo_description{String} Get the page's SEO Descriptionpage.seo_metatags{String} Get the page's SEO Metatagspage.keywords{String} Get the page's keywords

Dashboard PageLink

descriptionThis page shows all the published courses that a student is currently enrolled in, but also exposes variables to access all courses within the school
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.status_types{Hash} Get the possible enrollment states to populate the status list for searchingpage.all_cards{Drops::DashboardCourseCard} Get all product cards (cards of any status) that are attached to the studentpage.enrolled_cards{Drops::DashboardCourseCard} Get all product cards in which the student is enrolledpage.not_enrolled_cards{Drops::DashboardCourseCard} Get all product cards attached to the student in which the student is not enrolledpage.current_collection_id{Number} Get the current collection idpage.current_collection_name{String} Get the current collection namepage.current_collection_slug{String} Get the current collection slugpage.communities{Drops::Community} Get all communities in which the student has access topage.has_search_query{Boolean} Does the page have a search query applied? True or false.page.search_query{String} Get the currently applied search query

Edit Course Review PageLink

descriptionThis is the page where a student can review a course. Specifically, this page is where the student edits a review that they've already made.
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.course_review{Drops::CourseReview} Get the course review data

Express Sign In PageLink

descriptionThis is the page that your users set their password on
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this page

Home PageLink

descriptionThis is the main landing page of the site. It is shown when someone visits the root url of your site (mysite.thinkific.com/), except when you have only one published course or bundle.
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.should_paginate_products{Boolean} Should the collection be paginated? Returns true if the number of pages in the collection is greater than 1. True or false.page.product_page_numbers{Array} Get available page numbers for pagination of the collectionpage.current_product_page{Number} Get the current product's pagepage.has_products{Boolean} Does the collection have products? True or false.page.products{Drops::Product} Get the products to be rendered on the page

My Account PageLink

descriptionThis is the page where a student can view and edit their account details.
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.timezone_options{Hash} Get timezone optionspage.site_locale_options{Hash} Get locale optionspage.has_student_locale_selection_enabled{Boolean} Does the student have locale selection enabled? True or False

My Account Billings PageLink

descriptionThis is the page where a student can view their saved billing information (if any).
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.edit_billings_form{String} Get the edit billings form htmlpage.has_form_errors{Boolean} Does the form have errors? True or falsepage.form_error_messages{Array} Get the form error messagespage.form_error_count{Number} Get the form error count

My Account Certificates PageLink

descriptionThis is the page where a student can view their certificates. Note: This page is only shown if the site owner has the Completion Certificates feature.
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.enrollments_with_certificates{Drops::Enrollment} Get enrollments with certificates

My Account Credit Card PageLink

descriptionThis is the page that the student can use to add/modify/delete their credit card
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.my_account_credit_card_form{String} Get credit card form htmlpage.header_without_links_required{Boolean} Is a header without links required? Defaults to true.

My Account Notifications PageLink

descriptionThis is the page where a student can view and edit their notifications settings.
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.allow_weekly_email_reminders{Boolean} Allow weekly email remainders? True or Falsepage.allow_discussion_question_answered_email{Boolean} Allow discussion question answered email? True or False

My Account Order PageLink

descriptionThis is the page where a student can view a single order in detail.
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.order{Drops::Order} Get the orderpage.created_dateGet the date that the order was created on

My Account Orders PageLink

descriptionThis is the page where a student can view their orders.
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.has_orders{Boolean} Does the account have any orders? True or falsepage.orders{Drops::Order} Get the account's orders

My Account Password PageLink

descriptionThis is the page under 'My Account' where a user can change their password.
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this page

New Course Review PageLink

descriptionThis is the page where a student can review a course. Specifically, this page is where the student creates the review in the first place.
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.course_review{Drops::CourseReview} Get the course review data

Password Reset PageLink

descriptionThis is the page where a student will land after following the 'change password' link from their email. Here they can change their password.
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this page

Password Reset Request PageLink

descriptionThis is the page where a student can request a change of their password
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this page

Password Reset Sent PageLink

descriptionThis is the page where a student will land after requesting a change of password. Displays a message to check their email.
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this page

Paypal Confirm PageLink

descriptionThis is the page that a buyer lands on after going through the PayPal Express Checkout process. It is the last step where they must confirm the purchase.
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.paypal_confirmation_form{String} Get paypal confirmation form htmlpage.product_display_price{String} Get the product's display pricepage.product{Drops::Product} The product being purchasedpage.secure_payment_badge_url{String} Get the secure payment badge url

Prelaunch PageLink

descriptionThis page is shown instead of the homepage if the tenant does not have any published courses yet. It is used to capture email address of new leads.
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this page

Prelaunch Thank You PageLink

descriptionThis is the page that a user is shown after they have entered their email address on the Prelaunch Page.
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this page

Sign In PageLink

descriptionThis is the page that your users sign in on
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.has_remote_signin{Boolean} Does the user have a remote sign-in? True or falsepage.has_linkedin_enabled{Boolean} Does the user have LinkedIn enabled? True or falsepage.has_facebook_enabled{Boolean} Does the user have Facebook enabled? True or falsepage.has_google_enabled{Boolean} Does the user have Google enabled? True or falsepage.supports_remote_auth{Boolean} Supports remote auth? Always returns false. DEPRECATED (2018/08)page.linkedin_oauth_url{String} User LinkedIn oAuth Urlpage.facebook_oauth_url{String} User Facebook oAuth Urlpage.google_oauth_url{String} User Google oAuth Urlpage.tenant_oauth_url{String} Always returns '' (empty string). DEPRECATED (2018/08)page.tenant_auth_text{String} Always returns '' (empty string). DEPRECATED (2018/08)page.sign_up_url{String} Get the sign-in urlpage.forgot_password_url{String} Get the forgot password urlpage.sign_in_url{String} Get the sign-in urlpage.social_providers{Array} Get enabled social providers for the tenant with the following attributes: oauth_url, class and fa_icon

Sign Up PageLink

descriptionThis is the page that your users sign up on
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.has_remote_signin{Boolean} Does the user have a remote sign-in? True or falsepage.has_linkedin_enabled{Boolean} Does the user have LinkedIn enabled? True or falsepage.has_facebook_enabled{Boolean} Does the user have Facebook enabled? True or falsepage.has_google_enabled{Boolean} Does the user have Google enabled? True or falsepage.supports_remote_auth{Boolean} Supports remote auth? Always returns false. DEPRECATED (2018/08)page.linkedin_oauth_url{String} User LinkedIn oAuth Urlpage.facebook_oauth_url{String} User Facebook oAuth Urlpage.google_oauth_url{String} User Google oAuth Urlpage.tenant_oauth_url{String} Always returns '' (empty string). DEPRECATED (2018/08)page.tenant_auth_text{String} Always returns '' (empty string). DEPRECATED (2018/08)page.sign_up_url{String} Get the sign-in urlpage.forgot_password_url{String} Get the forgot password urlpage.sign_in_url{String} Get the sign-in urlpage.social_providers{Array} Get enabled social providers for the tenant with the following attributes: oauth_url, class and fa_icon

Social Sign Up PageLink

descriptionThis is the page that the user will land after authenticating through an external social provider. The user will be redirected here either if the social provider doesn't send us their email or if the site requires custom profile fields or if it has terms and privacy policies to be agreed upon before the registration.
contextavailable UNKNOWN
locatordescriptionpage.page_identifier{String} The unique identifier for this pagepage.requiring_email{Boolean} Does the user needs to fill their emailpage.has_remote_signin{Boolean} Does the user have a remote sign-in? True or falsepage.has_linkedin_enabled{Boolean} Does the user have LinkedIn enabled? True or falsepage.has_facebook_enabled{Boolean} Does the user have Facebook enabled? True or falsepage.has_google_enabled{Boolean} Does the user have Google enabled? True or falsepage.supports_remote_auth{Boolean} Supports remote auth? Always returns false. DEPRECATED (2018/08)page.linkedin_oauth_url{String} User LinkedIn oAuth Urlpage.facebook_oauth_url{String} User Facebook oAuth Urlpage.google_oauth_url{String} User Google oAuth Urlpage.tenant_oauth_url{String} Always returns '' (empty string). DEPRECATED (2018/08)page.tenant_auth_text{String} Always returns '' (empty string). DEPRECATED (2018/08)page.sign_up_url{String} Get the sign-in urlpage.forgot_password_url{String} Get the forgot password urlpage.sign_in_url{String} Get the sign-in urlpage.social_providers{Array} Get enabled social providers for the tenant with the following attributes: oauth_url, class and fa_icon

Student Certificate PageLink

descriptionThis is the page used to display a certificate issued to a student for completing an enrollment in a course. Certificates are generated and students are then provided a link to this page in the course player.
locatordescriptionpage.certificate_id{Number} Get the unique ID that identifies this certificate.page.course{String} Get the name of the course that the student has completed.page.credential_image_url{String} Get the URL to the certificate as an image filetype. (for downloads use the pdf_path)page.expired{Boolean} Whether the certificate has expired or not.page.expiry_date{String} Get the date that the certificate expires.page.is_certificate_owner{Boolean} Whether the current_user is the student that this certificate belongs to.page.is_preview{Boolean} Whether the page being rendered is in preview mode?page.issue_date{String} Get the date that the certificate was issued.page.pdf_path{String} Get the URL to the certificate as a PDF file.page.student_name{String} The name of the student that was issued the certificate.page.school{String} The name of the school that the certificate was issued from.