get
https://sandbox-api.softpoint.io/interface/v1/locations/YOUR_LOCATION_ID/terminals/28958
Fetches a single terminal by ID, returning its full configuration.
Request Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer YOUR_ACCESS_TOKEN |
Request Parameters
Path Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| location_id | integer | Yes | Location the terminal belongs to. |
| terminal_id | integer | Yes | ID of the terminal to retrieve. |
cURL Example
curl --request GET \
--url https://sandbox-api.softpoint.io/interface/v1/locations/748962/terminals/5923 \
--header "Authorization: Bearer YOUR_ACCESS_TOKEN"
Success Response
{
"terminals": {
"id": 5923,
"id_external": "xjz945",
"status": 1,
"location_id": 748962,
"serial_number": "d9g65gf8",
"tid": null
}
}
Response Fields
| Field | Type | Description |
|---|---|---|
| terminals | object | The terminal record. |
| terminals.id | integer | Terminal ID. |
| terminals.id_external | string | External identifier. |
| terminals.status | integer | Status. |
| terminals.location_id | integer | Owning location. |
| terminals.serial_number | string | Device serial number. |
| terminals.tid | string | null |
The full object also includes device model, mode, tip configuration, pairing details, and timestamps, mirroring the fields returned by Retrieve All Terminals.
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 | Terminal returned |
| 401 | Token missing, expired, or invalid |
Workflow Placement
A read used to confirm a single device's configuration.
Notes
- The single record is returned under a
terminalskey (singular object, not an array).
Common Mistakes
- Expecting a top-level object rather than one nested under
terminals.