GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/groups/{groupId}/endpoints
?order={order}
&orderDirection={orderDirection}
&pageSize={pageSize}
&pageNr={pageNr}
Gets the list of endpoints on a given group.
Request Information
URI Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| gsmKey |
The GSM console keycode. |
string |
Required |
| siteId |
The site identifier. |
string |
Required |
| groupId |
The group identifier. |
string |
Required |
| order |
Used to determine the order field. Valid values are "hostname", "firstseen", "lastseen", "agentversion", "lastinfected". Default value is "hostname". |
string |
None. |
| orderDirection |
Used to sort the data. "A" for ascending, "D" for descending. If orderDirection is omitted or invalid, the data will be sorted in ascending order. |
string |
None. |
| pageSize |
Specifies the number of records being returned. |
integer |
Default value is 50 |
| pageNr |
Specifies the page number. Can be used to retrieve the next batch of records. Default value is 1. |
integer |
Default value is 1 |
URI Sample(s)
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/groups/4f08f3ad-7688-4d40-98a6-89bbf7df3daf/endpoints
|
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/groups/4f08f3ad-7688-4d40-98a6-89bbf7df3daf/endpoints?pageSize=100&pageNr=3
|
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/groups/4f08f3ad-7688-4d40-98a6-89bbf7df3daf/endpoints?order=lastseen&orderDirection=A
|
Body Parameters
None.
Response Information
Resource Description
Information about the list of endpoints on a given group.
GetEndpointsResponseModel| Name | Description | Type | Additional Information |
|---|---|---|---|
| TotalAvailable |
Use this value to determine if you need to retrieve additional pages of data. If TotalAvailable is larger than PageNr * PageSize then more endpoints are available. |
integer |
None. |
| PageNr |
The number of the page that was request. |
integer |
None. |
| PageSize |
The size of the page that was requested. |
integer |
None. |
| Endpoints |
List of endpoint records. |
Collection of GetEndpointsResponseModel_Endpoint |
None. |
Sample Response
{
"TotalAvailable": 2,
"PageNr": 1,
"PageSize": 50,
"Endpoints": [
{
"Seq": 1,
"EndpointId": "78afdc93-e373-4313-a94a-27f9c8492c50",
"HostName": "MyComputer1",
"GroupName": "Test Group",
"FirstSeen": "2025-06-06T19:07:33.205864Z",
"LastSeen": "2025-06-06T19:07:33.205864Z",
"AgentVersion": "9.0.13.58",
"LicenseKey": "9BDA-93F5-A3F3-41EA-B506",
"Expired": false,
"LastChangesUserId": "2b8851a1-254e-4386-a813-2d0530eafddd",
"MachineId": "8CB84F54CDCB4A54A68E79504F1A2013:::FE46CE0C07F642088EFBD4DB6D89FC5F:::FE46CE0C07F642088EFBD4DB6D89FC5F",
"PolicyId": "5e61772b-5b71-494f-82c2-707032bcba4e",
"VM": false,
"AgentLanguage": "en",
"FriendlyPCName": "",
"GroupId": "eb385324-8906-4520-be3b-d9612b2129e4",
"PolicyName": "Test Policy",
"LastInfected": "2025-08-06T19:07:33.205864Z",
"InfectedNow": false,
"NumUsers": 1,
"MaxUsers": 2,
"InternalIP": "10.154.132.139",
"MACAddress": "5A-B2-17-D7-28-55",
"ADDomain": "domain.webroot.com",
"ADOU": "Webroot.Computers",
"Workgroup": "WORKGROUP",
"CurrentUser": "Paul",
"Mac": false,
"WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit",
"LastPublicIP": "95.193.240.204",
"Deactivated": false,
"LastScanSeq": "1213012990",
"ModifiedDate": "2025-10-30T19:07:33.205864Z",
"IsolationStatus": "UNISOLATED",
"ActiveModules": [
"endpoint"
]
},
{
"Seq": 2,
"EndpointId": "44dae2a5-5459-48de-b445-976ed8004e0b",
"HostName": "MyComputer2",
"GroupName": "Test Group",
"FirstSeen": "2025-01-06T19:07:33.205864Z",
"LastSeen": "2025-01-06T19:07:33.205864Z",
"AgentVersion": "9.0.13.58",
"LicenseKey": "9BDA-93F5-A3F3-41EA-B506",
"Expired": false,
"LastChangesUserId": "fe249355-cde6-45c7-96b6-c80fca5e0f08",
"MachineId": "F577F47F31A94D6E8BA5C4255ED1522E:::B775FE9C49AA4AB8A3B2F7C4C524FFF7:::B775FE9C49AA4AB8A3B2F7C4C524FFF7",
"PolicyId": "66671f02-5087-4571-a262-3de34bc739d8",
"VM": false,
"AgentLanguage": "en",
"FriendlyPCName": "",
"GroupId": "061c9995-add3-4193-ad9e-3d7ca7af0244",
"PolicyName": "Test Policy",
"LastInfected": "2025-05-06T19:07:33.205864Z",
"InfectedNow": false,
"NumUsers": 1,
"MaxUsers": 4,
"InternalIP": "10.202.150.154",
"MACAddress": "F0-C8-1C-E0-68-FE",
"ADDomain": "domain.webroot.com",
"ADOU": "Webroot.Computers",
"Workgroup": "WORKGROUP",
"CurrentUser": "Paul",
"Mac": false,
"WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit",
"LastPublicIP": "95.7.185.136",
"Deactivated": false,
"LastScanSeq": "1566150615",
"ModifiedDate": "2025-10-23T19:07:33.205864Z",
"IsolationStatus": "UNISOLATED",
"ActiveModules": [
"endpoint"
]
}
]
}
<GetEndpointsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
<Endpoints>
<GetEndpointsResponseModel_Endpoint>
<ADDomain>domain.webroot.com</ADDomain>
<ADOU>Webroot.Computers</ADOU>
<ActiveModules xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>endpoint</d4p1:string>
</ActiveModules>
<AgentLanguage>en</AgentLanguage>
<AgentVersion>9.0.13.58</AgentVersion>
<CurrentUser>Paul</CurrentUser>
<Deactivated>false</Deactivated>
<EndpointId>78afdc93-e373-4313-a94a-27f9c8492c50</EndpointId>
<Expired>false</Expired>
<FirstSeen>2025-06-06T19:07:33.205864Z</FirstSeen>
<FriendlyPCName></FriendlyPCName>
<GroupId>eb385324-8906-4520-be3b-d9612b2129e4</GroupId>
<GroupName>Test Group</GroupName>
<HostName>MyComputer1</HostName>
<InfectedNow>false</InfectedNow>
<InternalIP>10.154.132.139</InternalIP>
<IsolationStatus>UNISOLATED</IsolationStatus>
<LastChangesUserId>2b8851a1-254e-4386-a813-2d0530eafddd</LastChangesUserId>
<LastInfected>2025-08-06T19:07:33.205864Z</LastInfected>
<LastPublicIP>95.193.240.204</LastPublicIP>
<LastScanSeq>1213012990</LastScanSeq>
<LastSeen>2025-06-06T19:07:33.205864Z</LastSeen>
<LicenseKey>9BDA-93F5-A3F3-41EA-B506</LicenseKey>
<MACAddress>5A-B2-17-D7-28-55</MACAddress>
<Mac>false</Mac>
<MachineId>8CB84F54CDCB4A54A68E79504F1A2013:::FE46CE0C07F642088EFBD4DB6D89FC5F:::FE46CE0C07F642088EFBD4DB6D89FC5F</MachineId>
<MaxUsers>2</MaxUsers>
<ModifiedDate>2025-10-30T19:07:33.205864Z</ModifiedDate>
<NumUsers>1</NumUsers>
<PolicyId>5e61772b-5b71-494f-82c2-707032bcba4e</PolicyId>
<PolicyName>Test Policy</PolicyName>
<Seq>1</Seq>
<VM>false</VM>
<WindowsFullOS>Windows 7 Service Pack 1 (Build 7601) 64bit</WindowsFullOS>
<Workgroup>WORKGROUP</Workgroup>
</GetEndpointsResponseModel_Endpoint>
<GetEndpointsResponseModel_Endpoint>
<ADDomain>domain.webroot.com</ADDomain>
<ADOU>Webroot.Computers</ADOU>
<ActiveModules xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>endpoint</d4p1:string>
</ActiveModules>
<AgentLanguage>en</AgentLanguage>
<AgentVersion>9.0.13.58</AgentVersion>
<CurrentUser>Paul</CurrentUser>
<Deactivated>false</Deactivated>
<EndpointId>44dae2a5-5459-48de-b445-976ed8004e0b</EndpointId>
<Expired>false</Expired>
<FirstSeen>2025-01-06T19:07:33.205864Z</FirstSeen>
<FriendlyPCName></FriendlyPCName>
<GroupId>061c9995-add3-4193-ad9e-3d7ca7af0244</GroupId>
<GroupName>Test Group</GroupName>
<HostName>MyComputer2</HostName>
<InfectedNow>false</InfectedNow>
<InternalIP>10.202.150.154</InternalIP>
<IsolationStatus>UNISOLATED</IsolationStatus>
<LastChangesUserId>fe249355-cde6-45c7-96b6-c80fca5e0f08</LastChangesUserId>
<LastInfected>2025-05-06T19:07:33.205864Z</LastInfected>
<LastPublicIP>95.7.185.136</LastPublicIP>
<LastScanSeq>1566150615</LastScanSeq>
<LastSeen>2025-01-06T19:07:33.205864Z</LastSeen>
<LicenseKey>9BDA-93F5-A3F3-41EA-B506</LicenseKey>
<MACAddress>F0-C8-1C-E0-68-FE</MACAddress>
<Mac>false</Mac>
<MachineId>F577F47F31A94D6E8BA5C4255ED1522E:::B775FE9C49AA4AB8A3B2F7C4C524FFF7:::B775FE9C49AA4AB8A3B2F7C4C524FFF7</MachineId>
<MaxUsers>4</MaxUsers>
<ModifiedDate>2025-10-23T19:07:33.205864Z</ModifiedDate>
<NumUsers>1</NumUsers>
<PolicyId>66671f02-5087-4571-a262-3de34bc739d8</PolicyId>
<PolicyName>Test Policy</PolicyName>
<Seq>2</Seq>
<VM>false</VM>
<WindowsFullOS>Windows 7 Service Pack 1 (Build 7601) 64bit</WindowsFullOS>
<Workgroup>WORKGROUP</Workgroup>
</GetEndpointsResponseModel_Endpoint>
</Endpoints>
<PageNr>1</PageNr>
<PageSize>50</PageSize>
<TotalAvailable>2</TotalAvailable>
</GetEndpointsResponseModel>