Skip to content

Overview

Here are the following endpoints that we offer in our REST API. Each endpoint links to the relevant information in our reference documentation, with practical examples of the various requests.

EndpointDescription
AccountManage information regarding your Nuki Web account
Manage sub-accounts with access to your devices
AccountUserManage users to whom smart lock authorisations are assigned
AddressView addresses, or listings, which your device or devices are attributed to
Particularly useful for SHS
AddressReservationView reservations, or bookings, attributed to an address
Generate and issue authorizations for the reservation
AddressToken
AdvancedApiNumerous features only available with the Advanced API
Manage webhooks and perform actions triggering webhooks
ApikeyManage API access
Company
Notification
OpenerLists the officially supported opener brands and models
Note: to operate your opener, use the smartlock endpoint
ServiceManage connected third-party services
SmartlockGet information regarding your devices
Lock and unlock your devices
SmartlockAuthManage app authorisations for your devices
Manage keypad codes for your devices
Smartlock Authorisations are attributed to an AccountUser
SmartlockLogGet logs from your device