get
https://sandbox-api.softpoint.io/interface/v1/locations/YOUR_LOCATION_ID/terminals
Lists the terminals registered to a location, returning device details, status, and the most recent transaction time for each.
Request Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer YOUR_ACCESS_TOKEN |
Request Parameters
Path Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| location_id | integer | Yes | Location whose terminals are listed. |
A user_id may be supplied to identify the acting user.
cURL Example
curl --request GET \
--url https://sandbox-api.softpoint.io/interface/v1/locations/65924/terminals \
--header "Authorization: Bearer YOUR_ACCESS_TOKEN"
Success Response
{
"terminals": {
"current_page": 1,
"data": [
{
"id": 8372,
"id_external": "mfk672",
"status": 1,
"location_id": 65924,
"location_name": "Granite Peak Cafe",
"serial_number": "xgfrg7t",
"name": "Front Counter",
"global_manufacturer_terminal": "Verifone VX 820",
"global_terminal_mode": "Counter Service",
"global_tip": "Pay at the Counter",
"last_transaction": "2023-04-21 13:45:03",
"app_version": "8.1.14",
"revenue_center_name": "Main Counter",
"connected_reader": 1
}
],
"per_page": 100,
"last_page": 3,
"total": 250
}
}
Response Fields
| Field | Type | Description |
|---|---|---|
| terminals | object | Paginator wrapper. |
| terminals.data | array | Terminal records. |
| data[].id | integer | Terminal ID. |
| data[].serial_number | string | Device serial number. |
| data[].name | string | Friendly name. |
| data[].status | integer | Status. |
| data[].global_manufacturer_terminal | string | Device make/model. |
| data[].global_terminal_mode | string | Operating mode. |
| data[].last_transaction | string | Timestamp of the last transaction. |
| data[].connected_reader | integer | Whether a reader is attached. |
| data[].revenue_center_name | string | Associated revenue center. |
Error Responses
Unauthorized / Token Expired
{
"error": {
"code": 10759,
"message": "Operation timed out. Please try again.",
"details": { "Exception": "Token has expired" }
}
}
Status Codes
| Code | Description |
|---|---|
| 200 | Terminals returned |
| 401 | Token missing, expired, or invalid |
Workflow Placement
A read used to inventory devices at a location and select a terminal_id for payments.
Notes
- The paginator is nested under a
terminalskey; iterate pages for large fleets.
Common Mistakes
- Reading
dataat the top level instead of underterminals.