Cyan Web API - Version 1

GET api/devices/{deviceId}

            Gets a single device resource within a tenant.

Request Information

Parameters

Name	Description	Additional information
deviceId	The deviceId to locate.	Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "deviceId": "a06d07f8-3d86-4f6b-b908-d2bebf7a518b",
  "tenantId": "4fd9b571-54c2-4cf2-bbbd-052b15e82130",
  "deviceGroupId": "4a2524c7-bbd5-4e07-9d78-81391ae567f6",
  "name": "sample string 4",
  "description": "sample string 5",
  "manufacturerDeviceId": "sample string 6",
  "manufacturer": "sample string 7",
  "model": "sample string 8",
  "versionInfo": "sample string 9",
  "phoneNumber": "sample string 10",
  "isBlocked": true,
  "connectedDateUtc": "2026-03-14T07:25:16.1878578+00:00",
  "imei": "sample string 12",
  "macAddress": "sample string 13",
  "serialNumber": "sample string 14",
  "bluetoothName": "sample string 15",
  "createdDateUtc": "2026-03-14T07:25:16.1878578+00:00",
  "updatedDateUtc": "2026-03-14T07:25:16.1878578+00:00"
}

application/xml, text/xml

Sample:

<DeviceRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
  <CreatedDateUtc>2026-03-14T07:25:16.1878578+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-03-14T07:25:16.1878578+00:00</UpdatedDateUtc>
  <BluetoothName>sample string 15</BluetoothName>
  <ConnectedDateUtc>2026-03-14T07:25:16.1878578+00:00</ConnectedDateUtc>
  <Description>sample string 5</Description>
  <DeviceGroupId>4a2524c7-bbd5-4e07-9d78-81391ae567f6</DeviceGroupId>
  <DeviceId>a06d07f8-3d86-4f6b-b908-d2bebf7a518b</DeviceId>
  <Imei>sample string 12</Imei>
  <IsBlocked>true</IsBlocked>
  <MacAddress>sample string 13</MacAddress>
  <Manufacturer>sample string 7</Manufacturer>
  <ManufacturerDeviceId>sample string 6</ManufacturerDeviceId>
  <Model>sample string 8</Model>
  <Name>sample string 4</Name>
  <PhoneNumber>sample string 10</PhoneNumber>
  <SerialNumber>sample string 14</SerialNumber>
  <TenantId>4fd9b571-54c2-4cf2-bbbd-052b15e82130</TenantId>
  <VersionInfo>sample string 9</VersionInfo>
</DeviceRepresentation>