Per-Org Nodes summary

GET {baseURl}/v2/devices/nodes
Summary of device information for nodes in an organization.

Example
https://clarity-data-api.clarity.io/v2/devices/nodes?org=myorgVD43

Headers

• x-api-key: the API key string.

Request

query parameter		description
org	string required	The ID of the organization. Find it under the user profile section in Dashboard. Example "myorgVD43"

Response

attribute		description
lifeStage	object	Current state of a node's life stage. See LifeStage.
nodeId	string	The node ID (marked on the physical device). Example "A0000001"
sku	string	The device's unique Stock-Keeping Unit code. Example "CLA02-00001"
model	string	The marketed name of the node. Example "Node-S Global"
pairedAccessoryModules	array	List of paired accessory modules (if any). See Paired Accessory Module.
location	GeoJSON object	The configured location of the devic.

Example GeoJSON object

{
    "coordinates": [
        -122.2687187,  // longitude
        37.8712728     // latitude
    ],
    "type": "Point"
}

LifeStage

attribute		description
stage	string	One of: purchased, configured, working, or decommissioned.
when	string	The ISO 8601 time where the node entered the given stage.

Paired Accessory Module

attribute		description
accessoryId	string	The device ID of the module (printed on the module's label). Example "M0000001"
sku	string	The module's unique Stock-Keeping Unit code. Example "CLA-WIND02"

Example 200 Response

{
    "lifeStage": {
        "stage": "working",
        "when": "2022-07-19T12:00:53.680Z"
    },
    "nodeId": "A0000001",
    "sku": "CLA02-00001",
    "model": "Node-S Global",
    "pairedAccessoryModules": [
        {
            "accessoryId": "M0000001",
            "sku": "CLA-WIND02"
        }
    ],
    "location": {
        "type": "Point",
        "coordinates": [
            -122.301600740904,
            37.8792496314065
        ]
    }
}