Skip to content

Fleet Management

Utilities for managing multiple robots within an account or workspace.

ListRobotIDs

Retrieves a list of robot IDs the user has access to, filtered by optional criteria.
The list includes all known robots, regardless of their current connection state.

Request

filter RobotFilter required

RobotFilter defines the conditions for selecting robots.
All specified fields are combined using an AND condition.

Field Message Type Description
location_id string An empty location_id return all robots assigned
to all locations created and owned by API key user.
JSON Request Example
  {
    "filter": {
      "locationId": "location-123"
    }
  }

Response

A response message has 2 fields:

Field Message Type Description
total_robots int32 Total number of robots.
robot_ids List of string This might not have all the robot IDs if there are too many.
It will have all the robot IDs if the number of
robot_ids is same as total_robots.
JSON Response Example
  {
    "totalRobots": 5,
    "robotIds": [
      "pennybot-abc123",
      "pennybot-def456",
      "pennybot-ghi789",
      "pennybot-jkl012",
      "pennybot-mno345"
    ]
  }

Errors

ErrorCode Description
PERMISSION_DENIED Attempting to retrieve Robot IDs with a location_id you don't own.
Tips: check the spelling of all location_id values.