Minut API (v1)

A reference to Minut's HTTP API.

For an introductory guide to the API, see https://minut.com/developers.

Authentication

OAuth

Access Code

Security scheme type: OAuth2
authorizationCode OAuth Flow
Authorization URL: https://api.minut.com/v1/oauth/authorize
Token URL: https://api.minut.com/v1/oauth/token
Scopes:
  • all -

    access all endpoints accessible to the user

Devices

Get devices

Returns a list of all devices the authenticated user has access to.

Authorizations:

Responses

200

A list of devices

get /devices
https://api.minut.com/v1/devices

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
}

Get a device

Returns a device

Authorizations:
path Parameters
device_id
required
string

Device ID

Responses

200

A Device

401

User is not authorized access

404

The Device does not exist

get /devices/{device_id}
https://api.minut.com/v1/devices/{device_id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
}

Update a device

Update one or multiple fields of a device.

This endpoint also allows you to change the settings for a device.

Allowed notifications are:

Type Description
push A push notification is sent to the user's phone
Authorizations:
path Parameters
device_id
required
string

Device ID

Request Body schema: application/json

Configuration values to change on a device

description
string

The custom name of the device

home
string
timezone
string

The Olson ID for a timezone, e.g., Europe/Stockholm

glassbreak_config
object

This field is only used for the 1st generation of Minut Smart Home alarms and is used for activating glassbreak detection for a specific time duration.

quiet_hours
object
room_type
string
location
object
reactions
Array of objects (Reaction)
homekit_enabled
boolean
insights
object
listening_mode
string
Enum: "on" "off" "interval"

The operational mode of the microphone. If set to 'on' the microphone will be constantly enabled. This is the default operational mode. Setting the mode to 'interval' will enable the microphone every few seconds. 'off' disables the microphone.

nightlight_mode
string
Enum: "off" "timebased" "lightbased"
nightlight_start_at
string

The relative local time the night light will be enabled.

nightlight_end_at
string

The relative local time the night light will be disabled.

hap_reset_request
boolean

Responses

200

An updated device

400

Bad input

401

User is not authorized access

404

The Device does not exist

put /devices/{device_id}
https://api.minut.com/v1/devices/{device_id}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
}

Get temperature readings

Authorizations:
path Parameters
device_id
required
string

Device ID

query Parameters
start_at
string

The date-time to start fetching data from

end_at
string

The date-time to stop fetching data from

raw
boolean

Returns raw data as received from the device

format
string
Enum: "compact" "readable"

The format of the returned data. If set to 'compact' the resulting values will be of the form [, ]. If set to "readable" the values will be of the form "{time:, value:}"

include_min_max
boolean

Whether the resulting values should include the min and max values of the data for the required time duration.

Responses

200

Temperature readings

401

User is not authorized access

404

The Device does not exist

get /devices/{device_id}/temperature
https://api.minut.com/v1/devices/{device_id}/temperature

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
}

Get humidity readings

Authorizations:
path Parameters
device_id
required
string

Device ID

query Parameters
start_at
string

The date-time to start fetching data from

end_at
string

The date-time to stop fetching data from

raw
boolean

Returns raw data as received from the device

format
string
Enum: "compact" "readable"

The format of the returned data. If set to 'compact' the resulting values will be of the form [, ]. If set to "readable" the values will be of the form "{time:, value:}"

include_min_max
boolean

Whether the resulting values should include the min and max values of the data for the required time duration.

Responses

200

Humidity readings

401

User is not authorized access

404

The Device does not exist

get /devices/{device_id}/humidity
https://api.minut.com/v1/devices/{device_id}/humidity

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
}

Get barometric pressure readings

Authorizations:
path Parameters
device_id
required
string

Device ID

query Parameters
start_at
string

The date-time to start fetching data from

end_at
string

The date-time to stop fetching data from

raw
boolean

Returns raw data as received from the device

format
string
Enum: "compact" "readable"

The format of the returned data. If set to 'compact' the resulting values will be of the form [, ]. If set to "readable" the values will be of the form "{time:, value:}"

include_min_max
boolean

Whether the resulting values should include the min and max values of the data for the required time duration.

Responses

200

Pressure readings

401

User is not authorized access

404

The Device does not exist

get /devices/{device_id}/pressure
https://api.minut.com/v1/devices/{device_id}/pressure

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
}

Get sound level readings

Authorizations:
path Parameters
device_id
required
string

Device ID

query Parameters
start_at
string

The date-time to start fetching data from

end_at
string

The date-time to stop fetching data from

raw
boolean

Returns raw data as received from the device

format
string
Enum: "compact" "readable"

The format of the returned data. If set to 'compact' the resulting values will be of the form [, ]. If set to "readable" the values will be of the form "{time:, value:}"

include_min_max
boolean

Whether the resulting values should include the min and max values of the data for the required time duration.

Responses

200

Average sound level

401

User is not authorized access

404

The Device does not exist

get /devices/{device_id}/sound_level
https://api.minut.com/v1/devices/{device_id}/sound_level

Response samples

Content type
application/json
Copy