Skip to main content
GET
/
devices
List Devices
curl --request GET \
  --url https://api.example.com/devices
{
  "success": true,
  "total": 123,
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "ip": "<string>",
      "port": 123,
      "created_at": "<string>"
    }
  ]
}
Returns an array containing all devices that have been registered in the system. Each device entry includes basic identification and connection information.

​
Response

​
success
boolean
required
Indicates whether the request was successful
​
total
integer
required
Total number of registered devices
​
data
array
required
Array of device objects

​
Example Request

curl -X GET https://your-server.com/devices

​
Example Response

{
  "success": true,
  "total": 2,
  "data": [
    {
      "id": "principal",
      "name": "Entrada Principal",
      "ip": "192.168.1.205",
      "port": 4370,
      "created_at": "2026-03-05 10:30:00"
    },
    {
      "id": "bodega",
      "name": "Bodega Principal",
      "ip": "192.168.1.207",
      "port": 4370,
      "created_at": "2026-03-06 14:20:00"
    }
  ]
}

​
Use Cases

  • Get an overview of all connected biometric devices
  • Display available devices in a management dashboard
  • Validate device IDs before making requests to specific devices

Build docs developers (and LLMs) love

Get started for freeTalk to us