API

Search the developer hub

Jump to a page or an endpoint.

Catalogue

Everything an organisation offers publicly — areas, products, add-ons, branding and rules.

The catalogue is the one public read in OPS25. It returns what an organisation sells, where they sell it, and the rules their booking flow enforces — enough to build your own quote calculator, coverage checker or price table without embedding anything.

It needs no credentials and works from a server as well as a browser.

What is in it

The response still names its first object operator, which predates the product settling on “organisation”. It is the organisation, and renaming it would break every booking page live today.

  • operator — display name, slug, public id, maximum hire length, today's date in the organisation's own timezone, booking branding (logo, colour, terms URL, permit and collection notices) and the delivery time periods they offer.
  • rules — the booking rules that constrain what a customer may order: lead times, blackout dates, per-area and per-product restrictions.
  • productGroups, products, addOns, areas — the sellable catalogue, filtered to what the organisation has chosen to publish. A product group, such as a waste type, holds its variants, such as sizes; each variant is a products entry naming its groupId, and a customer books one. addOns links a group to the products offered with it on the extras step, which carry the add_on booking mode when they cannot be booked on their own.

Use it responsibly

The response carries Cache-Control: no-store, but that is about shared caches, not your own application. Cache it in your app for a few minutes. Public endpoints share a 240 requests per minute ceiling across all callers, so a page that reads the catalogue on every visitor request will eventually rate-limit somebody else's booking.

today is returned in the organisation's timezone precisely so you do not have to guess it from the browser — use it when validating dates rather than the visitor's own clock.

GET/api/public/{organisation}/catalog

Read an organisation's public booking catalogue: branding, service areas, products, their variants and add-ons.

  • Stable — breaking changes get a deprecation window and a changelog entry.
  • No credentials. Safe to call from a browser or a server.

Path parameters

NameDescription
organisationThe organisation's booking slug, as it appears in their booking page URL.

Errors

StatusWhen
404No organisation has that slug, or their booking page is switched off.