Quire documentation

Guides for everyone who uses Quire, and the reference for everyone who builds on it. Pick the guide for the work you do.

Start with your role, then follow the topic guides for the task in front of you. Developers can use the full English API reference alongside any language version of these guides. Operators should begin with the installation runbook and keep the backup and upgrade guides available before making changes.

• Administrators

  Setting up an organisation: people, roles, sign-in, branding, languages, email and records

• Teachers

  Building courses, writing pages together, setting and marking work

• Learners

  Finding courses, studying offline, and making Quire comfortable to read

• Developers

  The REST API, OAuth, webhooks and the MCP server

• API reference

  Every endpoint and webhook event, generated from the OpenAPI document

• Operators

  Installing, upgrading, backing up and rotating keys on a self-hosted Quire

Administration and teaching topics

• Organisation settings

  Addresses, default language, switches and graded roles

• Plan and billing

  What each plan includes, usage, changing plan, metered add-ons

• Sharing between organisations

  The shared space, and how a shared course runs in a mirror

• Extensions

  What is built in, and switching it on or off

• Live session and video providers

  Your own BigBlueButton, Zoom, Teams, Meet, Jitsi, Cloudflare Stream, Mux or Bunny account

• AI features

  Providers, features, policy, budget and who read tutor conversations

• Policies and acceptable use

  Publishing policies, acceptance, and acceptable use enforcement

• Content bank

  Reusing files and interactive content across courses

Integration guides

• n8n

  n8n workflows, with the Quire community node

• Zapier

  Zapier, through webhooks and the REST API

• Make

  Make scenarios, through webhooks and the REST API

• HubSpot

  HubSpot contacts, companies, workflows and the contact record

• LTI 1.3

  External learning tools, and H5P

• Single sign-on

  Your identity provider over OpenID Connect or SAML, and SCIM provisioning

Conventions in these guides

• A path such as /admin/users is a page on your organisation’s address, for example https://acme.quirelms.com/admin/users.
• What you can see depends on your role. If a page in a guide is missing for you, your administrator has not given your role that permission.
• Quire never deletes something without saying what will happen first. Where a guide says “remove”, expect a confirmation that names the consequence.