How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kontakt.io External Device API

External Device feature is a method of adding arbitrary external devices to the system. Such devices have MAC, unique id, and other virtual attributes, but they cannot be managed (configured).

Kontakt.io External Device API is one of 30 APIs that Kontakt.io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include External Device. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a changelog, and rate-limit docs.

This API exposes 5 operations across 4 paths, and defines 57 schemas. It is described by OpenAPI 3.2.0, at version 10.

Requests are made against 2 base URLs: https://dm-api.cloud.us.kontakt.io, https://dm-api.cloud.uk.kontakt.io.

5 operations 4 paths 57 schemas 1 DELETE1 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
10
Base URL
https://dm-api.cloud.us.kontakt.io
Authentication
HTTP Bearer, API Key, API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 3

Kontakt.io External Device API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer_token). An API key is passed in the header as Api-Key (api_key). An API key is passed in the header as Api-Key (management_api_key). By default, every request must be authenticated.

  • bearer_token — Provide a JWT in the Authorization: Bearer header. This is the standard authentication method for all API requests. Obtain a token via the OAuth2 Client Creden…
  • api_key — Deprecated — do not use for new integrations. This method exists solely for backward compatibility and will be removed in a future release. Use JWT Bearer toke…
  • management_api_key — Special management API Key with additional privileges used by authorized users.

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

External Device 5

External Device feature is a method of adding arbitrary external devices to the system. Such devices have MAC, unique id, and other virtual attributes, but they cannot be managed…

POST
/device/delete
Delete an external device
1 param body → 200401404422
POST
/device/external
Create a single external device
body → 200422
POST
/device/external/import
Import external devices
body → 200
GET
/device/external/import
Get status of the import process
→ 200
DELETE
/device/external/import/{jobKey}
Resets status of external devices import process started by the POST /device/external/import call
1 param → 200

Schemas 57

The contract defines 57 schemas that model the data the API accepts and returns. The most detailed are NewExternalDevice (12 properties), ConfigBle (12 properties), LocalAlertingSettings (9 properties), PowerSavingSettings (9 properties). Each schema is shown below with its type and property counts.

OccupancyInclusionZones
array
Inclusion zones. Areas included in occupancy counting. Applicable only in seat occupancy. Zone ids must match seat ids from Smart Location system. It's a virtu…
Polygon
object
2 properties
Dispenser
object
Dispenser settings for UHH dispenser beacons. Maps to PIDs dispensermodelid (0x917E) and dispenserdetectionparams (0x917F). Requires soapdispenser capability a…
2 properties
DeploymentInfo
object
Information about device's deployment.
4 properties 1 required
ApiError
object
5 properties
StitchingPivotLocal
object
Pivot (rotation point) of the image in the device image's local coordinates.
2 properties 2 required
OccupancyPhysicalSettings
object
Occupancy settings. Only applicable to devices with occupancy capability.
7 properties
LockDetailsConfirmationId
string
The value included in the DeviceChangedEvent.UPDATED to confirm that a specific configuration has been applied on a device
PendingBeaconConfig
Pending Beacon Configuration.
DeploymentStatus
string
Current deployment status of this device - e.g. whether is it deployed or not. ENDOFLIFE means the device is not going to be used anymore. Can occur for many r…
NewExternalDevice
object
12 properties
LocalAlertingSettings
object
Device local alerting settings.
9 properties
UniqueId
string
Unique identifier of a device.
ConfigBle
object
General BLE advertising settings.
12 properties
ExternalDeviceImportResult
object
Detailed result details of finished external devices import.
3 properties
LowBatterySettings
object
Device low battery settings.
2 properties
LocationInfo
object
Information about device location.
8 properties
IrTransmitterSettings
object
IR Transmitter setting.
3 properties
EditableGatewayConfig
object
Gateway (e.g. Portal Light) settings that can be changed via API
1 property
ConfigButton
object
Button settings.
3 properties
ConfigIBeacon
object
iBeacon settings.
4 properties
ExternalDeviceImportStatus
string
Status of the external device import process
TemperatureProbe
object
Settings for a temperature probe.
5 properties
HumidityProbe
object
Settings for a humidity probe.
5 properties
Device
object
DeviceEditableVirtualAttributes
object
Set of read-write editable virtual attributes.
7 properties
PowerSavingSettings
object
Power Saving settings
9 properties
DeviceType
string
General type of device.
DeviceDataRole
string
Type of access granted to this device.
DeviceModel
string
Kontakt.io internal model name of the device. Multiple products may have the same model name. Managed 3rd party devices will all have PARTNERDEVICE.
BeaconConfig
Full beacon-type configuration.
DisplaySettings
object
Device display settings.
4 properties
JobStatus
string
Job status.
ConfigLocksResponse
object
1 property
AccelerometerSettings
object
Accelerometer settings.
6 properties
TemperatureProbesSettings
object
Settings for temperature probes.
3 properties
UpdatedDate
string
Informs when the object has been updated.
BuzzerSnoozing
object
Buzzer snoozing settings for Temperature Monitor Pro devices. Maps to PID buzzersnoozedurationm (0x917D).
2 properties
ConfigEddystone
object
Eddystone settings.
5 properties
IrReceiverSettings
object
IR Receiver setting.
3 properties
HumidityProbesSettings
object
Settings for humidity probes.
1 property
BleScanSettings
object
BLE scanning setting. Can be used for fingerprinting.
5 properties
OccupancyExclusionZones
array
Exclusion zones. Areas excluded from occupancy counting like windows, heaters, etc. Applicable only in static room occupancy. It's a virtual attribute.
ExternalDeviceImportResponse
object
3 properties 2 required
StitchingPose
object
3 properties 3 required
PendingGatewayConfig
Pending Gateway (e.g. Portal Light) Configuration.
CreatedDate
string
Informs when the object has been created.
LockDetails
object
1 property
DeviceMacs
object
Collection of MAC addresses associated with the device.
5 properties
ConfigEid
object
Eddystone-EID settings.
2 properties
OccupancyAllSettings
Occupancy settings. Only applicable to devices with occupancy capability.
DeviceCategory
string
Category of the device, whether it's a moving (TAG) or static (INFRASTRUCTURE) device.
StitchingPivotWorld
object
Pivot (rotation point) of the image in the world coordinates that are shared between stitched devices. Origin is top left corner.
2 properties 2 required
FirmwareInfo
object
Details about device's firmware.
3 properties 3 required
StitchingPairMinimal
object
2 properties 2 required
SensorSettings
object
Device sensor settings.
2 properties
ExternalDeviceImportJobResetResponse
object
sdf
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kontaktio-external-device-api-openapi.yml Raw ↑

Other APIs Kontakt.io publishes across the network.

Kontakt.io Buildings API
Kontakt.io Campuses API
Kontakt.io Colocations API
Kontakt.io Command API
Kontakt.io Config API
Kontakt.io Device (3rd party) API
Kontakt.io Device API
Kontakt.io Device (Portal Beam) API
Kontakt.io Device tags API
Kontakt.io Eddystone API
Kontakt.io Entity Integration API
Kontakt.io Firmware API
Where this information came from

This is an independent, third-party profile of Kontakt.io External Device API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.