Skip to main content
GET
/
v1
/
terminals
List Terminals
curl --request GET \
  --url https://your-endpoint.moduluslabs.io/v1/terminals \
  --header 'x-api-key: <api-key>'
{
  "terminals": [
    {
      "connectionId": "abc123xyz",
      "terminalId": "TERM-001",
      "deviceId": "TERM-001",
      "connectedAt": "2024-01-15T10:30:00.000Z",
      "lastActivity": "2024-01-15T10:35:00.000Z",
      "status": "online",
      "metadata": {}
    }
  ],
  "count": 1,
  "timestamp": "2024-01-15T10:35:30.000Z"
}
This endpoint requires HMAC-SHA256 authentication. See Authentication for signature computation details.

​
Terminal ID Usage

The response includes both connectionId and deviceId for each terminal:
  • deviceId (Recommended) - Stable identifier that persists across reconnections
  • connectionId - Temporary identifier that changes when a terminal reconnects
Use deviceId when initiating payments for reliable terminal targeting.

Authorizations

​
x-api-key
string
header
required

HMAC-SHA256 authentication. Requires three headers: x-api-key (your API key), x-timestamp (ISO 8601 timestamp), and x-signature (Base64-encoded HMAC-SHA256 signature). See Authentication documentation for signature computation.

Response

List of active terminals

​
terminals
object[]
required

List of available terminals

​
count
integer
required

Total number of terminals

​
timestamp
string<date-time>
required

ISO 8601 timestamp of the response