Skip to main content
GET
/
v1
/
scanner
/
robots
List robots
curl --request GET \
  --url http://localhost:3000/v1/scanner/robots
{
  "robots": [
    {
      "id": "<string>",
      "display_id": "<string>",
      "label": "<string>",
      "name": "<string>",
      "status": "<string>",
      "is_active": true,
      "has_tote": true,
      "active_tote_id": "<string>"
    }
  ],
  "stats": {
    "total": 123,
    "online": 123,
    "offline": 123,
    "idle": 123,
    "delivering": 123,
    "charging": 123,
    "error": 123
  }
}

Query Parameters

status
string

Filter by status

Example:

"idle"

is_active
string

Filter by active state (true/false)

Example:

"true"

Response

200 - application/json

List of robots with stats

robots
object[]
required
stats
object
required