Skip to content

Website data feed

If your website is built by you or an agency (Astro, WordPress, a headless CMS, a static site generator), it can read your public Linyup data as JSON and show it in its own design: your studio details, offers, plans, class schedule, events and courses. Every item carries the link that books or buys it, so the visitor lands in your Linyup booking flow. When you have your own booking domain, the links use it.

The feed shares only what your public booking page already shows. It never shares contacts, bookings, payments or anything private.

  • Install the Website add-on. The website data feed is part of it from the Studio plan, and is on as soon as Website is installed. You can switch it off under Website → Configure.
  • As the owner, open Settings → Website data and create one website key per website. Give each key a name (usually the website’s address) and list the websites allowed to use it.

A studio can hold up to 5 active keys. Switching the feed off (or removing Website) pauses it but keeps your keys, so the websites work again as soon as it is back on. Revoking a key stops that one website within a minute.

A website key looks like lyp_pk_live_…. It is a publishable key: it sits in your website’s page source, so it is not a secret. What it gives you is control over which websites read your data, how much, and the ability to switch one website off without touching the others.

Send it in the X-Linyup-Key header, or as ?key= in the address (handy in a browser, where it avoids an extra preflight request).

Allowed websites (up to 10 per key): typing example.ch also allows www.example.ch. localhost:<port> is allowed over plain http while a site is being built. A key with no websites listed works on any website. A browser on a website that is not on the list is refused; a request with no browser origin, such as a build server or curl, is always answered.

Website keys are not API keys: they read only the feed below, and an API key does not work here.

All requests are GET to https://api.linyup.com, and every endpoint takes ?locale=en|de|fr|it. Without it, the answer is in your studio’s own language. Offer and plan texts come in the requested language when a translation exists; cancellation terms always stay in the original.

Endpoint Returns
GET /v1/public/{slug} Your studio: name, description, timezone, currency, logo, address, places, the coaches you show, social links, and links to booking, shop and Space
GET /v1/public/{slug}/offers Classes and appointments: text, picture, tags, drop-in and trial price, appointment lengths and prices, the plans that include a class, your booking page’s sections, and a booking_url each
GET /v1/public/{slug}/plans Plans with their prices and intro offers, and a buy_url each
GET /v1/public/{slug}/schedule?from=&to= Bookable classes in a window: time, place, coach, capacity, spots left, and a booking_url each
GET /v1/public/{slug}/events Your published events that have not ended, and your organization’s: dates, place, description, the program, and a url to the event page each
GET /v1/public/{slug}/courses Your published courses that have not finished: dates, number of lessons, outline, place, coach, price, places left, whether sales are open, and a booking_url each

{slug} is your studio’s public address, the part after /public/ in your booking link.

For the schedule, from and to take a date (2026-10-12, a day in your studio’s timezone) or a full date and time with an offset. The default is today and the next 14 days; one request covers at most 60 days and 200 classes.

Terminal window
curl -H "X-Linyup-Key: lyp_pk_live_…" \
"https://api.linyup.com/v1/public/your-studio/schedule?locale=de"
const res = await fetch(
'https://api.linyup.com/v1/public/your-studio/offers?locale=en&key=lyp_pk_live_…'
)
const { data, sections } = await res.json()

Lists come as { "object": "list", "locale": "…", "data": [ … ] }.

Event programs keep their times as printed at the venue ("09:00" on "2026-11-01"), not converted to another time zone. A course whose sales have closed is still listed, with booking_open: false.

A good split for a static site: read the studio, offers, plans, events and courses when the site is built, since they change rarely, and add a rebuild hook (below) so the site is rebuilt when they do. Read the schedule live in the browser, or show it with the booking embed, because it changes all day.

If your website is built once and then published (Netlify, Vercel, Cloudflare Pages and the like), your host gives you a build hook: an address that starts a new build when it is called. Paste it into the website key under Settings → Website data → Edit.

Linyup then calls it, with a POST, when something your website is built from changes: studio details, offers, plans, events or courses. It checks every 10 minutes, so a change reaches your site within about 10 minutes plus your build time. New bookings, places taken in a course and the class schedule never trigger a build. Right after you save a hook, Linyup calls it once, so you can see it works: the key shows when it was last called and whether it answered.

The hook must be an https:// address on a public host. If it fails, Linyup tries again within the hour.

Answers are cached for up to a minute, so a change you make in Linyup shows in the feed within about a minute of the next request (a static site also needs a new build: see the rebuild hook above). Requests are rate limited per visitor and per key; a 429 answer means slow down and try again shortly.

Errors come as { "error": { "code": "…", "message": "…" } }.

Status Code Meaning
400 invalid_request A parameter is wrong, for example to before from
401 unauthenticated The key is missing, unknown or revoked
403 insufficient_scope The key is not allowed on this website
404 not_found No such studio for this key, or no such endpoint
409 feature_unavailable The feed is switched off, Website is not installed, or the studio is not on the Studio plan
422 window_too_wide The schedule window is longer than 60 days
429 rate_limited Too many requests