1KEY Developers
API reference

Products

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

Log in to send these requests to your organization from this page.

Products

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

GET /products/{product_id}

Get a product

Parameters

Name In Type Description
product_id required path string

Responses

200 The product. · returns a Product

Errors

401 unauthenticated Missing, malformed, revoked or unknown API key.
404 not_found No such resource, or it is not your organization's.
GET /products

List products

Products in the registry, by id. q matches every word against the maker, label and description. fingerprint (with optional firmware) returns the one product a device with that fingerprint is. Any API key can read products.

Parameters

Name In Type Description
q optional query string
manufacturer_id optional query string
fingerprint optional query string manufacturer_id:product_type:product_id, each 4-digit hex.
firmware optional query string The device's firmware version, with fingerprint.
limit optional query integer, 1–100, default 50
starting_after optional query string ID of the last item on the previous page.

Responses

200 A page of products.

Errors

400 invalid_request The request is malformed or a field is invalid.
401 unauthenticated Missing, malformed, revoked or unknown API key.