GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/groups

Gets the list of groups on a given GSM site.

Request Information

URI Parameters

Name	Description	Type	Additional Information
gsmKey	The GSM console keycode.	string	Required
siteId	The site identifier.	string	Required

URI Sample(s)


GET	https://unityapi.webrootcloudav.com/service/api/console/gsm/893E-946D-C5AE-4C7B-8274/sites/1e8058d7-9a9b-42c7-8fda-678d55ae9e06/groups

Body Parameters

None.

Response Information

Resource Description

Information about the list of groups on a given GSM site.

GetGroupsResponseModel

Name	Description	Type	Additional Information
TotalCount	Total number of groups available.	integer	None.
Groups	List of group details records.	Collection of GetGroupsResponseModel_Group	None.

Sample Response

{
  "TotalCount": 2,
  "Groups": [
    {
      "Endpoints": 99,
      "GroupCode": "-243758577",
      "GroupId": "2c81fe08-f162-4888-a650-6ad530dda1d2",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "2fc6fefd-7346-4cd9-aab9-3a819c26f66f",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 9,
      "GroupCode": "-272489539",
      "GroupId": "7ba2a2b6-8fdc-4151-8cc6-a01be54da68e",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "f8cc5c07-5c51-4433-b8e5-90a9147116fa",
      "GroupPolicyName": "Test Policy 2"
    }
  ]
}

<GetGroupsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <Groups>
    <GetGroupsResponseModel_Group>
      <Endpoints>99</Endpoints>
      <GroupCode>-243758577</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>2c81fe08-f162-4888-a650-6ad530dda1d2</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>2fc6fefd-7346-4cd9-aab9-3a819c26f66f</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>9</Endpoints>
      <GroupCode>-272489539</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>7ba2a2b6-8fdc-4151-8cc6-a01be54da68e</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>f8cc5c07-5c51-4433-b8e5-90a9147116fa</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>