Skip to main content

Building with Minut

Welcome to the developer documentation for Minut's API. Minut turns each home into a small stream of signals — sound level, temperature, humidity, motion, occupancy and the events derived from them — and exposes it all over a single REST API. Whether you want to read live sensor values, react to a noise disturbance the moment it happens, or build an integration that thousands of hosts can connect to, this is where you start.

If you prefer to dive straight into endpoints, the complete API Reference lists every route, parameter and response.

What are you building?​

While all our users (including our own apps) use the same API, different kinds of users might use it to achieve different goals. To help you find the information you need, we have split parts of this documentation into two sections:

  1. You're a property manager or host using the API to collect data from your Minut devices.
    This is by far the most common use case. To get started read the Authentication for Users section.

  2. You're a partner building an integration that Minut users can use.
    This is for partners who want to build an integration with Minut, and make it available to other Minut users. To get started read the Authentication for Partners section.

Where to go next​

The documentation is organised roughly in the order you'll need it. Here's the high-level map:

Start here​

  • API Information — the two prerequisites for calling the API: a Minut account and an OAuth client. Read this first.
  • Architecture — how Minut works under the hood: what devices measure, how often they talk to the backend, and why that shapes the way you consume the API. A few minutes here will save you time everywhere else.
  • Authentication — how to obtain and refresh access tokens, split into For Users and For Partners.

Read the data​

  • Sensor Data — fetch the latest readings or historic time series for a device's sensors.
  • Configure Thresholds — set the limits (sound, temperature, humidity) that decide when a measurement turns into an event.

React to what happens​

  • Webhooks — the recommended way to receive events in real time: register an endpoint and Minut pushes each event to you as it's generated.
  • Fetching Events — pull events from the API after the fact, for backfilling history or reconciling after downtime.
  • Events Reference — the catalogue of event types you can receive and what each one means.

Manage access​

  • Managing Guests — create and manage guests so the right people have access to the right homes during a stay.

Reference​

  • API Reference — the full, always-up-to-date specification of every endpoint, parameter and response.

Not sure where to begin? Start with API Information and Authentication to get a working access token, then follow whichever section matches what you're building.