Northpass

Welcome to the Northpass Developer Hub!

The Northpass platform was purpose-built for developers to flex their creative muscles. Discover what's possible with our solution so that you can deliver the most impactful experiences within your products.

Start by browsing our guides to learn how to best interact with our APIs. Then, dive into our API Reference to see what's possible.

Get Started    API Reference

Variables Reference

What are variables?

Variables expose information about your school in a dynamic way. You can access the data about your courses, the current learner, and much more. Thanks to variables you can deliver dynamic content to your learners.

Types of variables

There are two types of variables - global and template-specific.

Global variables

Global variables are the ones that are exposed globally and can be used in all the templates.
Here's a table that shows the variables along with their types:

nametype
catalogCatalog
categoriesCategories
color_paletteColorPalette
coursesCourses
current_personPerson
current_schoolSchool
featuresFeatures
homepageHomepage
learning_pathsLearningPaths
messages
navigationsNavigations
params
training_eventsTrainingEvents
website_footerWebsiteFooter

Template-specific variables

These variables are visible only in specific templates. To learn more about the local variables available for each template, check out the list of available templates under Customizing Pages.

Updated 14 days ago


Variables Reference


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.