GET api/Devices?includeLatestReading={includeLatestReading}&includeProperties={includeProperties}

Gets all Devices you have access to.

Request Information

URI Parameters

Name	Description	Type	Additional information
includeLatestReading	Whether or not to include the latest reading in the response	boolean	Default value is False
includeProperties	Whether or not to include the Device Properties (i.e. Min/Max, etc). True by default. Setting this to false can speed up operation	boolean	Default value is True

Body Parameters

None.

Response Information

Resource Description

List of

GetDevicesResponse

Name	Description	Type	Additional information
Devices	Array of Devices	Collection of ConnectedDeviceStruct	None.
Messages	Array of messages	Collection of Message	None.
ServerInformation	Relevant information regarding the Server	ServerInformation	None.
VersionInformation	Relevant information regarding the API's version	VersionInformation	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "Devices": [
    {
      "NodeChannel": 1,
      "SerialNumber": "sample string 1",
      "Type": 1,
      "TypeName": "sample string 2",
      "SignalType": 0,
      "Controllable": true,
      "Schedulable": true,
      "Threshold": 1.0,
      "ReadingOverride": "sample string 3",
      "Specifications": "sample string 4",
      "Latitude": 1.0,
      "Longitude": 1.0,
      "Code": "sample string 5",
      "Allowance": 1,
      "DefaultValidationBeforeSpan": "00:00:00.1234567",
      "DefaultValidationBeforeLimit": 1,
      "DefaultValidationBeforeID": 1,
      "DefaultValidationBeforeEnable": true,
      "DefaultValidationBeforeName": "sample string 6",
      "DefaultValidationDuringSpan": "00:00:00.1234567",
      "DefaultValidationDuringLimit": 1,
      "DefaultValidationDuringID": 1,
      "DefaultValidationDuringEnable": true,
      "DefaultValidationDuringName": "sample string 7",
      "DefaultValidationAfterSpan": "00:00:00.1234567",
      "DefaultValidationAfterLimit": 1,
      "DefaultValidationAfterID": 1,
      "DefaultValidationAfterEnable": true,
      "DefaultValidationAfterName": "sample string 8",
      "ID": 9,
      "Name": "sample string 10",
      "Description": "sample string 11",
      "DataNodeID": 1,
      "DataNodeName": "sample string 12",
      "DecimalPlaces": 1,
      "ReadingType": 1,
      "ReadingUnitType": 1,
      "Category": "sample string 13",
      "Reading": {
        "DelayFromStart": 1,
        "TimeToRun": 2,
        "LastReading": "2025-11-09T21:24:36.6881906+10:00",
        "Type": 4,
        "Units": 5,
        "Value": "1.0",
        "NumericalValue": 1.0,
        "Notes": "sample string 6"
      },
      "ReadingMinValue": 1.0,
      "ReadingMaxValue": 1.0,
      "Lifespan": 1,
      "BandActionsEnabled": true,
      "ReadingValueBands": [
        {
          "ID": 1,
          "DisplayIndex": 2,
          "Description": "sample string 3",
          "BottomValue": 4.0,
          "TopValue": 5.0,
          "Color": "sample string 6",
          "AlertTriggerType": 0,
          "AlertType": 0,
          "AlertResendWaitTime": 7,
          "MaxAlertRepeat": 8,
          "OtherAlertTriggerValue": "sample string 9",
          "AutoAcknowledge": true,
          "NotifyAcknowledge": true,
          "ActionType": 0,
          "ActionTargetType": 10,
          "ActionTargetID": 12,
          "ActionValue": 13.0,
          "AlertCountRequired": 14
        },
        {
          "ID": 1,
          "DisplayIndex": 2,
          "Description": "sample string 3",
          "BottomValue": 4.0,
          "TopValue": 5.0,
          "Color": "sample string 6",
          "AlertTriggerType": 0,
          "AlertType": 0,
          "AlertResendWaitTime": 7,
          "MaxAlertRepeat": 8,
          "OtherAlertTriggerValue": "sample string 9",
          "AutoAcknowledge": true,
          "NotifyAcknowledge": true,
          "ActionType": 0,
          "ActionTargetType": 10,
          "ActionTargetID": 12,
          "ActionValue": 13.0,
          "AlertCountRequired": 14
        }
      ],
      "ConfiguredAlerts": [
        {
          "ID": 1,
          "Enabled": true,
          "Name": "sample string 3",
          "Description": "sample string 4",
          "AlertType": 0,
          "MaxRepeats": 5,
          "WaitTime": 6,
          "OwnerID": 7,
          "OwnerType": 10,
          "Type": 0,
          "CheckInControlled": true
        },
        {
          "ID": 1,
          "Enabled": true,
          "Name": "sample string 3",
          "Description": "sample string 4",
          "AlertType": 0,
          "MaxRepeats": 5,
          "WaitTime": 6,
          "OwnerID": 7,
          "OwnerType": 10,
          "Type": 0,
          "CheckInControlled": true
        }
      ]
    },
    {
      "NodeChannel": 1,
      "SerialNumber": "sample string 1",
      "Type": 1,
      "TypeName": "sample string 2",
      "SignalType": 0,
      "Controllable": true,
      "Schedulable": true,
      "Threshold": 1.0,
      "ReadingOverride": "sample string 3",
      "Specifications": "sample string 4",
      "Latitude": 1.0,
      "Longitude": 1.0,
      "Code": "sample string 5",
      "Allowance": 1,
      "DefaultValidationBeforeSpan": "00:00:00.1234567",
      "DefaultValidationBeforeLimit": 1,
      "DefaultValidationBeforeID": 1,
      "DefaultValidationBeforeEnable": true,
      "DefaultValidationBeforeName": "sample string 6",
      "DefaultValidationDuringSpan": "00:00:00.1234567",
      "DefaultValidationDuringLimit": 1,
      "DefaultValidationDuringID": 1,
      "DefaultValidationDuringEnable": true,
      "DefaultValidationDuringName": "sample string 7",
      "DefaultValidationAfterSpan": "00:00:00.1234567",
      "DefaultValidationAfterLimit": 1,
      "DefaultValidationAfterID": 1,
      "DefaultValidationAfterEnable": true,
      "DefaultValidationAfterName": "sample string 8",
      "ID": 9,
      "Name": "sample string 10",
      "Description": "sample string 11",
      "DataNodeID": 1,
      "DataNodeName": "sample string 12",
      "DecimalPlaces": 1,
      "ReadingType": 1,
      "ReadingUnitType": 1,
      "Category": "sample string 13",
      "Reading": {
        "DelayFromStart": 1,
        "TimeToRun": 2,
        "LastReading": "2025-11-09T21:24:36.6881906+10:00",
        "Type": 4,
        "Units": 5,
        "Value": "1.0",
        "NumericalValue": 1.0,
        "Notes": "sample string 6"
      },
      "ReadingMinValue": 1.0,
      "ReadingMaxValue": 1.0,
      "Lifespan": 1,
      "BandActionsEnabled": true,
      "ReadingValueBands": [
        {
          "ID": 1,
          "DisplayIndex": 2,
          "Description": "sample string 3",
          "BottomValue": 4.0,
          "TopValue": 5.0,
          "Color": "sample string 6",
          "AlertTriggerType": 0,
          "AlertType": 0,
          "AlertResendWaitTime": 7,
          "MaxAlertRepeat": 8,
          "OtherAlertTriggerValue": "sample string 9",
          "AutoAcknowledge": true,
          "NotifyAcknowledge": true,
          "ActionType": 0,
          "ActionTargetType": 10,
          "ActionTargetID": 12,
          "ActionValue": 13.0,
          "AlertCountRequired": 14
        },
        {
          "ID": 1,
          "DisplayIndex": 2,
          "Description": "sample string 3",
          "BottomValue": 4.0,
          "TopValue": 5.0,
          "Color": "sample string 6",
          "AlertTriggerType": 0,
          "AlertType": 0,
          "AlertResendWaitTime": 7,
          "MaxAlertRepeat": 8,
          "OtherAlertTriggerValue": "sample string 9",
          "AutoAcknowledge": true,
          "NotifyAcknowledge": true,
          "ActionType": 0,
          "ActionTargetType": 10,
          "ActionTargetID": 12,
          "ActionValue": 13.0,
          "AlertCountRequired": 14
        }
      ],
      "ConfiguredAlerts": [
        {
          "ID": 1,
          "Enabled": true,
          "Name": "sample string 3",
          "Description": "sample string 4",
          "AlertType": 0,
          "MaxRepeats": 5,
          "WaitTime": 6,
          "OwnerID": 7,
          "OwnerType": 10,
          "Type": 0,
          "CheckInControlled": true
        },
        {
          "ID": 1,
          "Enabled": true,
          "Name": "sample string 3",
          "Description": "sample string 4",
          "AlertType": 0,
          "MaxRepeats": 5,
          "WaitTime": 6,
          "OwnerID": 7,
          "OwnerType": 10,
          "Type": 0,
          "CheckInControlled": true
        }
      ]
    }
  ],
  "Messages": [
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    },
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    }
  ],
  "ServerInformation": {
    "CurrentTimeUTC": "2025-11-09T21:24:36.6881906+10:00",
    "BuildDateUTC": "2025-11-09T21:24:36.6881906+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  }
}