← All help topics

🧩 API & integrations

A fully documented open REST API so your other systems can read and write your linen data.

The portal has an open REST API so your own tools and sister systems (for example the maintenance app) can read and write the same data you see on screen β€” properties, linen sheets, laundries, the vault, invoices, statistics and the property groupings. It is described by a standard OpenAPI 3.1 document, so most API tools can import it and build a client for you. Being this open is deliberate: your data stays yours and is never locked in.

The documentation (open to anyone)

  • Browsable reference: open /api/docs β€” every endpoint with its parameters and example responses.
  • Machine-readable spec: /api/openapi.json β€” import it into Postman, Swagger UI, an SDK generator or your CI.
  • Version stamp: /api/version β€” the running version and build hash, handy for health checks.
Note Those three documentation endpoints are the only ones that work without signing in. Every endpoint that reads or writes your data requires authentication β€” there is no way to reach your linen data anonymously.

Signing in to the API

  • Data API (/api/v1/…): send an OIDC Bearer token from your identity provider β€” Authorization: Bearer <token>. Any admin, power-user or user token is accepted (admin can read and write; power-user and user are read-only). The token’s audience is not restricted, so a sister app on the same login can call this API with the signed-in user’s own token (single sign-on).
  • Laundry API (/api/laundry/…): a laundry connects with its own API key (Settings β†’ Laundries), not a user login β€” it fetches its confirmed jobs and uploads its invoices.

Example β€” list your properties: curl -H "Authorization: Bearer $TOKEN" https://YOUR-DOMAIN/api/v1/properties

Note The API is multi-tenant, exactly like the web app: each domain serves only its own data.
Tip Not sure where to start? Open /api/docs and try a GET /properties call β€” it needs only a read-only token.

Open the API documentation