1KEY Developers
Reference

API reference

Base URL https://api.1keyplatform.dev/v1. Every endpoint is generated from the OpenAPI contract, which you can download as openapi.yaml.

The buildings your organization manages. Every hub is at a site.

Hubs your organization owns.

1Key Intercoms your organization owns: the entry consoles at buildings' doors. They share hubs' scopes.

Your hubs together, or one site's. What they're connected by now, what needs attention, and how they did over the last 24 hours, 7 days or 30 days.

People in your organization, and invitations to join it.

Devices connected to a hub and their channels, read live from the hub.

A device's own configuration, such as a lock's auto-lock time.

Lock users, their PINs and cards, and the schedules the hub enforces.

Automations, schedules and remote triggers the hub keeps and runs, offline too.

Checking a device works before marking its setup complete. The hub runs the checks and keeps the mark.

Devices that join on their own when powered on, from their QR codes. Codes for a hub that is offline, or has never connected, are kept until it connects.

Actions sent to a hub's devices.

Events from your hubs, kept 30 days. Read your organization's log with one cursor, or one hub's events with its own.

Your organization, its API keys, their usage and request log, and your email alerts.

The device registry. Every Z-Wave product 1key knows, with its maker, manual and inclusion, exclusion and reset steps.