Get deviceBeta

GET

/v2/devices/{device_id}

Retrieves Device with the associated device_id.

Permissions:DEVICES_READ

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

device_id

string

Required

The unique ID for the desired Device.

Link to section

Response fields

Link to section

errors

Information about errors encountered during the request.

Link to section

device

The requested Device.

Link to section

Examples

GET /v2/devices/{device_id}

curl https://connect.squareup.com/v2/devices/device%3A995CS397A6475287 \
  -H 'Square-Version: 2024-04-17' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Response JSON

{
  "device": {
    "id": "device:995CS397A6475287",
    "attributes": {
      "type": "TERMINAL",
      "manufacturer": "Square",
      "model": "T2",
      "name": "Square Terminal 995",
      "manufacturers_id": "995CS397A6475287",
      "updated_at": "2023-09-29T13:12:22.365049321Z",
      "version": "5.41.0085",
      "merchant_token": "MLCHXZCBWFGDW"
    },
    "components": [
      {
        "type": "APPLICATION",
        "application_details": {
          "application_type": "TERMINAL_API",
          "version": "6.25",
          "session_location": "LMN2K7S3RTOU3"
        }
      },
      {
        "type": "CARD_READER",
        "card_reader_details": {
          "version": "3.53.70"
        }
      },
      {
        "type": "BATTERY",
        "battery_details": {
          "visible_percent": 5,
          "external_power": "AVAILABLE_CHARGING"
        }
      },
      {
        "type": "WIFI",
        "wifi_details": {
          "active": true,
          "ssid": "Staff Network",
          "ip_address_v4": "10.0.0.7",
          "secure_connection": "WPA/WPA2 PSK",
          "signal_strength": {
            "value": 2
          }
        }
      },
      {
        "type": "ETHERNET",
        "ethernet_details": {
          "active": false
        }
      }
    ],
    "status": {
      "category": "AVAILABLE"
    }
  }
}