Get Device Information

POST {{base_url}}/api/v2/device/find

Description

Find a device that is assigned to your company. It allows you to see the advanced information of the device specified by the deviceId (MAC address).

Response Body Contents

• _id (string): The unique identifier for the post request object.

• deviceId (string): The unique identifier of the device (also known as MAC).

• archived (boolean): Indicates whether the asset has been archived or not.

• assetName (string): The name of the asset.

• beaconType (string): The type of beacon associated with the asset (assetfloNearable or unknown)

• createdAt (number): The timestamp indicating when the asset was created, specified in milliseconds starting at the UNIX epoch (January 1, 1970 00:00:00 UTC).

• deviceType (string): The type of device (Tag or Locator).

• groups (array): An array of groups to which the asset belongs.

  • GroupCompanyId (string): The group ID to which the asset belongs.

• icon (string): The icon associated with the asset (tagIcon or locatorIcon)

• id (string): The unique identifier for the asset.

• isProvisioned (boolean): Indicates whether the asset is provisioned or not (true or false).

• organization (string): The organization associated with the asset, can be specified in the UI under Select Company dropdown (Assetflo Inc., SOTI, Amazon, etc).

• protocol (string): The communication protocol used by the asset (BLE,WIFI,LTE,IOX").

• source (string): The source of the asset (API).

• status (string): The status of the asset (active or inactive).

• updatedAt (number): The timestamp indicating when the asset was last updated, specified in milliseconds starting at the UNIX epoch (January 1, 1970 00:00:00 UTC).

• configurationId (string): The unique identifier for the asset's configuration.

• fixAsset (boolean): Indicates whether the asset is in a fixed position or not (true or false).

• isAnchor (boolean): Indicates whether the device is an anchor or not (true or false).

• location (object): object containing location coordinates of device

  • lat (number): The latitude coordinate of the device's location.
  • lng (number): The longitude coordinate of the device's location.
  • alt (number): The altitude of the device's location.

• uuid (string): The Universal Unique Idenitfier associated with the asset for it's specific network.

Request Body

{"deviceId"=>"Device MAC Address"}

HEADERS

RESPONSES

status: OK

{"_id":"636178633fe3bb06d32a5c10","deviceId":"de0366b789d8","archived":false,"assetName":"5G-de03","beaconType":"unknown","createdAt":1667332195543,"deviceType":"Tag","fixAsset":false,"groups":["GroupVehicleId"],"icon":"tagIcon","id":"de0366b789d8","isProvisioned":true,"organization":"assetflotest","protocol":"LTE","source":"API","status":"Active","updatedAt":1668181680559,"configurationId":"636d59c0e62bb0cdfd95076e","connectors":["DIG"],"isPush":true,"serialNo":"JU13214BA906","firmware":[{"firmwareId":"636d8f4ac51b3407c5ae05d1","protocol":"LTE","version":16},{"protocol":"BLE","version":3}],"noLocation":"used","geotabId":"b11","productId":10239}