Explore Plans
Mobile menu Close menu
iRobotiRobot

Robot Status

This Query returns the current status of your robot, as well as the time of its next scheduled job.

Developer info

API endpoint slug
irobot.get_current_status
Runtime method
performQuery("irobot.get_current_status")

Query fields

Robot name Dropdown list

Label
What is the name of your robot?
Slug
robot_name
Required
false
Can have default value
false

Ingredients

Current statusThe current status of the robot. Possible values are: 'running', 'paused', 'stopped', 'stuck', 'docking', and 'mid_mission_charging'

Slug
current_status
Filter code
Irobot.getCurrentStatus.CurrentStatus
Type
String
Example
running

Next scheduled missionThis represents the scheduled mission for the robot.

Slug
next_scheduled_mission
Filter code
Irobot.getCurrentStatus.NextScheduledMission
Type
Date with time (ISO8601)
Example
2020-07-08T04:17:06.000+05:00