The Minut API is a REST-based HTTP API with which you can write custom integrations with your own applications or Property Management System.
Please note that access to the Minut API is only available with our Enterprise subscription.
How to use the Minut API key
If you would like to access the Minut API and you have an Enterprise subscription, please send an email to hello@minut.com to request your API credentials (a client ID and secret). You will also need to tell us in general terms for what purpose and for what type of applications you wish to use the API.
Your use of the API is subject to our Terms of Use, so please read them carefully.
Install the API key
You can get access to the Minut API via our webapp (Log in with your Minut account)
1. Select the Minut API integration and click “Link”.
2. Enter your client ID and secret key. Click “Save”.
3. Follow the instructions generated by Minut.
Developer documentation
Minut's developer documentation is contained together with the API specification. The API reference is publicly available at api.minut.com, and you don't need to log in to read it. In the API documentation you will find:
How to authenticate using the API
An overview of the Minut architecture
How to setup and configure webhooks
The API specification
You'll find more information in our Minut API documentation.
The API reference has a Try it out option where you can enter your client ID and secret and send requests from the page. These are real API calls against your organization's live data, so use it with care.
API versions
v8: the latest version.
v7: the previous version, still available if you haven't migrated yet. Older versions (v1 to v6) redirect to the v7 reference.
TypeScript types
TypeScript types for the API are published as an npm package under the @minuthq scope, so your TypeScript code can use the same request and response formats shown in the reference.
If you have any questions reach out to our support team at hello@minut.com