Introduction

Loupe's REST API lets you read and manage what your library publishes with Loupe: events, rooms and bookings, pages, messages, maps, footfall and catalogue search.

Everything Loupe shows to your visitors, and most of what your team manages in the admin, is available over a plain HTTP API. Use it to put your agenda on another website, sync bookings with an internal tool, feed a screen at the entrance with live footfall, or run your own reports.

What you can build

  • Show your programme anywhere. Read published events and register people from your own site or app, or publish events from your own tools.
  • Connect bookings. List rooms and equipment, check availability, create reservations, configure rooms and close slots.
  • Reuse your content. Read, create and translate pages and their hierarchy.
  • Handle messages. Send contact forms and purchase suggestions to the library's inbox, and answer them from your own tools.
  • Search the catalogue. Query the catalogue connected to Loupe, with the same engine as your Loupe site.
  • Display footfall. Read live occupancy and the forecast for the day.
  • Work with maps. Fetch map definitions and the places they contain.
  • Report. Pull event and booking statistics for a period.

Base URL

All requests go to a single host, over HTTPS:

Shell
https://api.loupe.ch

Every path starts with /api. Two families of endpoints cover most integrations:

PrefixWho can call itTypical use
/api/public/…Anyone, no key neededWhat your visitors see: published events, rooms, pages, maps, footfall, catalogue search
/api/manager/…Staff, with an API keyWhat your team does in the admin: registrations, reservations, messages, statistics

Your first request

Public data needs no authentication. This returns the public profile of a library, here one with the slug riveville:

Shell
curl https://api.loupe.ch/api/public/organizations/riveville

The slug is the first segment of the library's Loupe address: https://app.loupe.ch/riveville.

To read what only your team can see, create an API key in the admin and send it in the X-Api-Key header:

Shell
curl https://api.loupe.ch/api/manager/statistics/cms-events \  -H "X-Api-Key: $LOUPE_API_KEY" \  -H "Accept: application/json"

Next steps

  • Authentication explains how keys work and what they can access.
  • Making requests covers organization scoping, formats, dates and languages.
  • The guides walk through each module with real requests.
  • The API reference lists every documented endpoint.