Get device details for a restaurant

Get details for the devices at a location. This includes POS terminal and handheld devices, and printers.

Securityoauth2

Request

header Parameters

Toast-Restaurant-External-ID

required

string <uuid>

The identifier for the restaurant.

Responses

200

Successful operation

400

Missing or invalid restaurant header.

401

Unauthorized.

403

Forbidden.

429

Too many requests.

500

An unexpected error occurred.

get/device-info

Request samples

curl
Java
Python

curl -i -X GET \
  https://toast-api-server/device-details/v1/device-info \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Toast-Restaurant-External-ID: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

Response samples

application/json

[{"deviceModel": "TT200",
"deviceModelName": "Toast Terminal",
"serialNumber": "cb5f9ea",
"deviceType": "POS",
"posDeviceInfo": {"posType": "TERMINAL",
"deviceName": "string",
"deviceId": "4f49a8734eb214d0",
"lastSyncedAt": "2025-04-01T12:00:00.000Z",
"primaryMode": "string",
"orderAutofireEnabled": true,
"pciCompliant": true,
"pciNonComplianceReason": "string",
"ipAddress": "string",
"ipType": "DHCP",
"macAddress": "string",
"networkName": "string",
"networkConnectionType": "WIFI",
"deviceUptimeMillis": 0,
"posAppVersion": "4.3.1",
"firmwareVersion": "string",
"androidOsVersion": "14.0",
"androidOsSdkLevel": 34,
"securityPatchVersion": "string"
},
"printerDeviceInfo": {"deviceName": "string",
"lastSyncedAt": "2019-08-24T14:15:22Z",
"firmwareVersion": "string",
"ipAddress": "string",
"ipType": "DHCP",
"macAddress": "string",
"gatewayAddress": "string",
"netmaskAddress": "string",
"printerPort": "string"
}
}
]