<h2 id="0a8xp7byy3q" data-toc-id="0a8xp7byy3q">Site API</h2>Welcome to the Siteglide Site API Docs!Siteglide is designed to give you total access to your data and to platform capabilities.If you don't see an endpoint you need you can create your own or contact us if you think it should be platform wide.Each Siteglide feature has it's own page with the various endpoints:<span data-type="mention" class="dark:bg-border bg-[#E9ECF1] px-1 py-0.5 text-sm shadow-none rounded-lg" data-id="eyJhcnRpY2xlSWQiOiI5NTczNjY1IiwiaGVscENlbnRlcklkIjoiaWc2OHp5YzdhMWYycDg1dyIsIm9yZ2FuaXphdGlvbklkIjoiNjc2MTgxMGE5ZDRjYWQwMzIwNGM1YzI3IiwibG9jYWxlIjoiZW4iLCJzdGF0ZSI6ImxpdmUifQ==-article" data-label="Forms">@Forms<span data-type="mention" class="dark:bg-border bg-[#E9ECF1] px-1 py-0.5 text-sm shadow-none rounded-lg" data-id="eyJhcnRpY2xlSWQiOiI4MzYxNDMxIiwiaGVscENlbnRlcklkIjoiaWc2OHp5YzdhMWYycDg1dyIsIm9yZ2FuaXphdGlvbklkIjoiNjc2MTgxMGE5ZDRjYWQwMzIwNGM1YzI3IiwibG9jYWxlIjoiZW4iLCJzdGF0ZSI6ImxpdmUifQ==-article" data-label="Categories">@Categories<span data-type="mention" class="dark:bg-border bg-[#E9ECF1] px-1 py-0.5 text-sm shadow-none rounded-lg" data-id="eyJhcnRpY2xlSWQiOiI4ODU5MzY3IiwiaGVscENlbnRlcklkIjoiaWc2OHp5YzdhMWYycDg1dyIsIm9yZ2FuaXphdGlvbklkIjoiNjc2MTgxMGE5ZDRjYWQwMzIwNGM1YzI3IiwibG9jYWxlIjoiZW4iLCJzdGF0ZSI6ImxpdmUifQ==-article" data-label="Using Collections with WebApps and Modules">@Using Collections with WebApps and Modules<span data-type="mention" class="dark:bg-border bg-[#E9ECF1] px-1 py-0.5 text-sm shadow-none rounded-lg" data-id="eyJhcnRpY2xlSWQiOiI0MDI1Nzk4IiwiaGVscENlbnRlcklkIjoiaWc2OHp5YzdhMWYycDg1dyIsIm9yZ2FuaXphdGlvbklkIjoiNjc2MTgxMGE5ZDRjYWQwMzIwNGM1YzI3IiwibG9jYWxlIjoiZW4iLCJzdGF0ZSI6ImxpdmUifQ==-article" data-label="Quickstart: WebApps">@Quickstart: WebApps<span data-type="mention" class="dark:bg-border bg-[#E9ECF1] px-1 py-0.5 text-sm shadow-none rounded-lg" data-id="eyJhcnRpY2xlSWQiOiI4MTM4NTAzIiwiaGVscENlbnRlcklkIjoiaWc2OHp5YzdhMWYycDg1dyIsIm9yZ2FuaXphdGlvbklkIjoiNjc2MTgxMGE5ZDRjYWQwMzIwNGM1YzI3IiwibG9jYWxlIjoiZW4iLCJzdGF0ZSI6ImxpdmUifQ==-article" data-label="CRM Users">@CRM Users<span data-type="mention" class="dark:bg-border bg-[#E9ECF1] px-1 py-0.5 text-sm shadow-none rounded-lg" data-id="eyJhcnRpY2xlSWQiOiI1MTA5MzQwIiwiaGVscENlbnRlcklkIjoiaWc2OHp5YzdhMWYycDg1dyIsIm9yZ2FuaXphdGlvbklkIjoiNjc2MTgxMGE5ZDRjYWQwMzIwNGM1YzI3IiwibG9jYWxlIjoiZW4iLCJzdGF0ZSI6ImxpdmUifQ==-article" data-label="Quickstart: eCommerce">@Quickstart: eCommerceTo find documentation for Siteglide Portal API, please follow this link - <a target="_blank" rel="noopener noreferrer" class="link" href="https://api.siteglide.co.uk/docs/">Portal API docs</a>\

Introduction

Feedback

Roadmap

Changelog

Luke Wakefield

Get Started

Quickstart Guides

Manage Sites, Users, Domains, Billing and more

Portal

Billing

Siteglide Billing

Billing Setup

Automatic Site Upgrades

Subscriptions and Changes

Invoices

Agencies

Agency Account

Clients

Site Copies

Add your own branding to the Siteglide Admin

Agency Whitelabelling

Users

Invite & Manage Users

User Roles

Sites

Introduction to Sites

Site Backups and Disaster Recovery

Go Live

Install & Manage Modules

Site Details

Site Users

Quickstart: Create a Site

Site Subscription

Domains

Introduction to Domains

Add a Fully Delegated Domain

Add an External Domain

Subdomain on a separate instance

How to setup a multi domain start page

Your Siteglide Account

Marketplace

Log and Manage Support Tickets in Siteglide

Tickets

Matt Jones

Developers

Install, and get started with our CLI. With it, you can make changes to your site's code, directly from your machine. 

Quickstart: CLI

Introduction to the Command Line Interface (CLI)

About CLI

Once CLI is installed, you need to make connections (sometimes called an environment) between a folder on your machine and a specific Siteglide site.

CLI Site Setup

Creating WebApps via CLI

CLI Changelog

The main commands you'll need when using Siteglide CLI

CLI Command Reference

CLI Troubleshooting

Liquid

How to use Liquid to get the most from Siteglide

Introduction to Liquid

The context object is a rich source of data about the environment where you are writing Liquid, whether that is a Page, Email etc. This article goes into detail about the different properties and how you can use them.

Reference - Exploring the Context Object

Learn to recognise different types of Liquid syntax

Liquid Tutorial 1 - Recognising the syntax of tags, outputs and filters

Liquid Tutorial 2 - Liquid variables and types

The parse_json tag can be used to create objects from a JSON string. These allow you to represent complex entities with properties, instead of using a bunch of separate variables. Dot notation is a useful way to access those properties later. 

Liquid Tutorial 3 - Creating Liquid objects and accessing their properties

How to use Liquid For Loops and Indexing to handle arrays. Also, how to use a key to access key maps, using categories as an example.

Liquid Tutorial 4- Creating and accessing arrays, including looping

So far we have created variables to store data manually and accessed that data, but often we want to access data that has been provided by external sources. A good place to start is looking at information about the URL and the current Page.

Liquid Tutorial 5 - Accessing data from the page and URL

Use if statements and case statements to control what happens based on context

Liquid Tutorial 6 - Logic

Using Categories from the context object as an example, we look at a special kind of object (maps) and how to access their properties.

Liquid Tutorial 7 - Looping over an object's properties

With the powerful include and render tag, you can use Liquid to pull in other Liquid files into the file you're working in. This allows you to access oven-ready Siteglide functionality and efficiently re-use your own content across your site.

Liquid Tutorial 8 - Joining Liquid files together with include/render

Liquid Tutorial 9 - Using WebApp and Module collections - Coming Soon

Improve the accuracy of your if statements by using the blank keyword to catch a range of falsy states.

Liquid Tutorial 10 - Truthiness in Logic: using Liquid to determine if a field is empty or blank

We have often been asked if we can add a feature where customers can directly add Liquid code to rich text fields, and have it evaluated and run on the Page. For major security reasons, this is not possible; it would make it so easy for malicious users to POST form data to your site and have a high level of access to critical information. However, you can allow certain Liquid-based functionality in a safe and controlled manner. 

How to safely trigger Liquid functionality when parsing a rich text field

GraphQL

About GraphQL

Tutorials

Tutorial 1 - Your First Query

Tutorial 2 - Pagination

Tutorial 3 - Filtering the Results

Tutorial 3 - (Answers)

Tutorial 4 - Advanced Filtering

Tutorial 4 - (Answers)

Tutorial 5 - Using Liquid to run GraphQL queries on your Site

Tutorial 6 - (Answers)

Tutorial 6 - Variables

Tutorial 7 - Sorting

Tutorial 8 - Building a Liquid API GET Endpoint Page powered by GraphQL queries

Tutorial 9 - Using Mutations to Create New Records

Tutorial 10 - Using Mutations to Edit a Record

Tutorial 11 - Using Mutations to Delete an Item

Tutorial 12 - Related Records and Datasources

Site API

Release Notes

Module - Blog - Changelog

Module - Events - Changelog

Module - FAQ - Changelog

Module - Menu - Changelog

Module - Secure Zones - Changelog

Module - Slider - Changelog

Module - System Files - Changelog

Siteglide Admin/API - Changelog

Configuration

Custom Field IDs

Field Types

Zapier Integration

Developer Marketplace

About Building Modules

Adding Payment to a Module

Create Folder Structure

Data & UI Module Example

Module Setup

File Structure

In this section, we'll add reference code which is relevant across Modules. Specific Modules may have further relevant reference material in their own sections of the docs.

Modules Reference

Site Template Modules - and How to Make Your Own

Submit Module for Approval

Theme Module Example

Updating Modules

Studio

Introduction to Studio

Copy a Site Template

Install Studio Module

Studio Page Editor

Dynamic Content in Studio

Studio AI Section Builder

Studio User Roles

Studio Themes

Install a Studio Theme

Studio Theme Publisher

Theme Sections

Theme Styling

SiteBuilder

Site Setup

Advanced Features

Extend SiteBuilder

Layouts

Styling

SiteBuilder is the quickest way to get started with Siteglide

About SiteBuilder and how it can help you rapidly build websites and applications

about-sitebuilder.md

design-to-code.md

pagebuilder.md

Get started with SiteBuilder in a few simple steps

quickstart-sitebuilder.md

Reference

Dashboard

Pages

Quickstart: Pages

About Pages

Page Settings

Page Editing

Code View & Toolbox

Custom Fields in Pages

Pages with Siteglide CLI

Accessing Page Data

Sometimes you may be asked by a third party to add a file to your site to prove ownership, or to provide helpful metadata to 3rd parties. This article explains how to use CLI to create a page with a file extension like .txt

Adding non-HTML files to your site with alternative file extensions

Preventing Duplicate Content

Content Sections

File Manager

Introduction to File Manager

About Assets

Assets File Structure

Accessing Assets

Migrating Assets

Tags for Assets

Assets Troubleshooting

Assets with CLI

Teleporting Scripts to the Head and Footer with siteglide_head_scripts and siteglide_footer_scripts or using context.exports to avoid duplicates

Siteglide Scripts Explained

Optimising Images on the Fly with Cloudinary

Optimising Images Natively with Cloudflare

Quickstart: Categories

About Categories

Filtering WebApps and Modules by Categories Using Liquid Parameters

This Article shows how you can use the category_array field to access the IDs of the Categories assigned to a WebApp or Module Item