List Terminals

Retrieve all terminals that belong to one merchant location. The response now mirrors Get Terminal but omits gateway-level details, making the payload lighter for dashboards and audits.

Endpoint

GET https://api.test.devs.beadpay.io/Locations/{locationId}/terminals

Required header

Name	Example	Notes
Authorization	Bearer eyJhbGciOiJS…	Same token used for other Terminal Management calls.

Path parameter

Name	Type	Description
locationId	string	Identifier of the merchant location that owns the terminals.

No query parameters are required; the call returns all terminals at that location.

Request example

curl -X GET \
  "https://api.test.devs.beadpay.io/Locations/123123/terminals" \
  -H "accept: */*" \
  -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>"

Response example (trimmed)

[
  {
    "id": "tlm_8e6b42",
    "created": "2025-04-24T22:56:18.337Z",
    "updated": "2025-04-24T23:05:41.102Z",
    "merchantId": "mrc_7f4a2d3e4b",
    "merchantLocationId": "123123",
    "name": "Front Counter POS",
    "description": "Main checkout terminal",
    "displayLogo": true,
    "webhookUrl": "https://example.com/webhooks/terminal/tlm_8e6b42",
    "isEnabled": true,
    "tenderTypes": ["ethereum"]
  }
]

Field descriptions

Field	Type	Description
id	string	Terminal identifier.
created, updated	string	UTC ISO-8601 timestamps.
merchantId	string	Merchant that owns the terminal.
merchantLocationId	string	Location you queried ({locationId}).
name, description	string	Friendly metadata.
displayLogo	boolean	Show Bead logo on hosted pages.
webhookUrl	string | null	Device-level webhook URL.
isEnabled	boolean	false → terminal cannot create new payments.
tenderTypes	array	Payment methods accepted (e.g., ethereum).

Response codes

HTTP status	Meaning	Body
200 OK	Terminals returned	JSON array (possibly empty).
404 Not Found	locationId unknown	{ "code": "LocationNotFound", "message": "Location 123123 does not exist." }
401 / 403	Invalid or expired token	Standard auth error payload

Usage tips

• Lightweight dashboards – The trimmed response is ideal for real-time device status views.

• Bulk audits – Compare the list against your asset inventory to find missing or disabled terminals.

• Need gateway data? – Call Get Terminal for the specific id; that endpoint still returns the full object including paymentGateways.

Related pages

Operation	Description
Create Terminal	Add a new device to this location.
Get Terminal	Retrieve full details (including paymentGateways) for one terminal.
Delete Terminal	Remove a device that is no longer needed.
Set / Delete Webhook	Manage device-level webhook URLs.