Description
Returns the run schedule previously set for an agent.
URL parameters
| Name |
Required |
Type |
Description |
AgentID |
True |
string |
Unique identifier of an agent. |
Responses
| Name |
Type |
Description |
Result |
string |
Success if the operation was successful. |
Schedule |
Schedule |
Information about the schedule. |
Sample request
curl -X GET 'https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Agent.GetSchedule&AgentID=11238'
Sample responses
XML
<AgentGetScheduleResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Result>Success</Result>
<Schedule>
<AgentID>11238</AgentID>
<Frequency>Daily</Frequency>
<Starts>2025-07-18 00:00:00</Starts>
<RepeatEvery>1</RepeatEvery>
<RepeatInterval>0</RepeatInterval>
<RepeatIntervalHour>24</RepeatIntervalHour>
</Schedule>
</AgentGetScheduleResponse>
JSON (add &ResponseFormat=JSON)
{
"Schedule": {
"AgentID": 11238,
"Frequency": "Daily",
"Starts": "2025-07-18 00:00:00",
"RepeatEvery": 1,
"RepeatInterval": 0,
"RepeatIntervalHour": 24
},
"JsonResult": {
"Command": "Agent.GetSchedule",
"AutoLoggedIn": false,
"WebConsoleKey": "",
"Result": "Success",
"ErrorCode": "",
"ErrorDescription": "",
"ErrorList": []
}
}