Agent.GetGroups

  • Published on Aug 25, 2026
  • 1 minute(s) read
  • bA
 Prev Next

Description

Returns a list of your Agent Groups with their AgentGroupID, Name, and Description.

Responses

Name Type Description
Result string Success if the operation was successful.
AgentGroup AgentGroup Information on all Agent Groups in the account.

Sample request

curl -X GET "https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Agent.GetGroups"

Sample responses

XML

<?xml version="1.0" encoding="utf-8"?>
<AgentGetGroupsResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <Result>Success</Result>
    <AgentGroupList>
        <AgentGroup>
            <AgentGroupID>22370</AgentGroupID>
            <Name>Testing</Name>
            <Description/>
        </AgentGroup>
        <AgentGroup>
            <AgentGroupID>22662</AgentGroupID>
            <Name>TestingAgain</Name>
            <Description/>
        </AgentGroup>
    </AgentGroupList>
    <RequestTimingsList>
        <RequestTiming>
            <Time>2026-08-18 14:48:46</Time>
            <Command/>
            <LastDescription/>
        </RequestTiming>
    </RequestTimingsList>
</AgentGetGroupsResponse>

JSON (add &ResponseFormat=JSON)

{
   "AgentGroup": [
    {
      "AgentGroupID": 22370,
      "Name": "Testing",
      "Description": ""
    },
    {
      "AgentGroupID": 22662,
      "Name": "TestingAgain",
      "Description": ""
    }
}  ],
  "JsonResult": {
    "Command": "Agent.GetGroups",
    "AutoLoggedIn": false,
    "WebConsoleKey": "",
    "Result": "Success",
    "ErrorCode": "",
    "ErrorDescription": "",
    "ErrorList": []
  }