Getting device information

Send a GET request to /device-details/v1/device-info endpoint of the device details API to obtain device details for all Toast POS devices for a location. For more information about the returned values, see About the Devices object.

The following curl command sends a GET request to the endpoint.

curl -i -x GET \ 'https://[toast-api-hostname]/device-api/v1/device-info' \ 1
 -H 'Toast-Restaurant-External-ID: 95a96d7b-dbf5-46d3-98c5-c65c8ad18021' \ 2
 -H 'Authorization: Bearer [token]' 3

1

Send a GET request to the /device-details/v1/device-info endpoint of the device details API.

2

Specify the GUID of the location that you want to get device details from. This must be the GUID of a single location. It cannot be the GUID of a location group.

3

Include an authentication token. For more information, see Authentication and restaurant access.

The following example shows the JSON response data for the GET request.

[
   {
       "serialNumber": "ABCDEFGHIJK1L", 1
       "deviceName": "POS Dining", 2
       "deviceModel": "TT200", 3
       "deviceId": "jan1a23b4567c8d9", 4
       "posAppVersion": "2.94.1" 5
   },
   {
       "serialNumber": "MNOP2QR3STU45",
       "deviceName": "Expo",
       "deviceModel": "TT500",
       "deviceId": "1a23b456c789d012",
       "posAppVersion": "2.95.0"
   },
   {
       "serialNumber": "VWXYZABC6DE78",
       "deviceName": "Pizza Prep",
       "deviceModel": "22in-I-Series-4-Value",
       "deviceId": "3456e789f0gh1234",
       "posAppVersion": "2.95.0"
   },
   {
       "serialNumber": "FGHIJKLM90NO1",
       "deviceName": "HH Dining",
       "deviceModel": "TG300",
       "deviceId": "567ijk890l1m2n34",
       "posAppVersion": "2.94.1"
   }
]

1

The serial number of the device.

2

The name given to the device using the Toast POS app.

3

The device model name.

4

The device ID, assigned by the Toast platform.

5

The Toast POS app version on the device.