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": "fc48ddba-cd4b-490e-b115-875caadeeada",
"HostName": "MyComputer1",
"GroupName": "Test Group",
"FirstSeen": "2025-06-26T11:19:40.9241373Z",
"LastSeen": "2025-06-26T11:19:40.9241373Z",
"AgentVersion": "9.0.13.58",
"LicenseKey": "3721-A291-E81E-47A9-BA79",
"Expired": false,
"LastChangesUserId": "af63f4d4-d7fc-4c5b-8ddf-319fa2f023cb",
"MachineId": "1E082AB4D21647248F9FB01B30FFD9AA:::8B011CB707C94092B1B7D09E8773CD23:::8B011CB707C94092B1B7D09E8773CD23",
"PolicyId": "30f9add0-8925-4bc2-86af-d96d4be9e86b",
"VM": false,
"AgentLanguage": "en",
"FriendlyPCName": "",
"GroupId": "54b59cfa-3526-48d4-b99c-99963b5fc746",
"PolicyName": "Test Policy",
"LastInfected": "2025-08-26T11:19:40.9241373Z",
"InfectedNow": false,
"NumUsers": 1,
"MaxUsers": 2,
"InternalIP": "10.213.47.211",
"MACAddress": "16-52-7E-66-1B-53",
"ADDomain": "domain.webroot.com",
"ADOU": "Webroot.Computers",
"Workgroup": "WORKGROUP",
"CurrentUser": "Paul",
"Mac": false,
"WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit",
"LastPublicIP": "95.97.179.50",
"Deactivated": false,
"LastScanSeq": "38392609",
"ModifiedDate": "2025-11-19T11:19:40.9241373Z",
"IsolationStatus": "UNISOLATED",
"ActiveModules": [
"endpoint"
]
},
{
"Seq": 2,
"EndpointId": "ba94d242-8254-4611-88a3-5c9532a45881",
"HostName": "MyComputer2",
"GroupName": "Test Group",
"FirstSeen": "2025-01-26T11:19:40.9241373Z",
"LastSeen": "2025-01-26T11:19:40.9241373Z",
"AgentVersion": "9.0.13.58",
"LicenseKey": "3721-A291-E81E-47A9-BA79",
"Expired": false,
"LastChangesUserId": "57615704-44a0-44f4-9be2-f6004a88802a",
"MachineId": "0E0C71AA0BF646B8B8BE07D62E5ACDE9:::EAE39EEFA79A4F18876320DE289F71C7:::EAE39EEFA79A4F18876320DE289F71C7",
"PolicyId": "4638229e-0e6e-4070-9dba-44bbd598097c",
"VM": false,
"AgentLanguage": "en",
"FriendlyPCName": "",
"GroupId": "8ad5b4b8-fe4d-49d7-b6ee-9e6baf5910f6",
"PolicyName": "Test Policy",
"LastInfected": "2025-05-26T11:19:40.9241373Z",
"InfectedNow": false,
"NumUsers": 1,
"MaxUsers": 4,
"InternalIP": "10.6.11.77",
"MACAddress": "53-E2-E4-EA-29-2B",
"ADDomain": "domain.webroot.com",
"ADOU": "Webroot.Computers",
"Workgroup": "WORKGROUP",
"CurrentUser": "Paul",
"Mac": false,
"WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit",
"LastPublicIP": "95.40.136.97",
"Deactivated": false,
"LastScanSeq": "251317016",
"ModifiedDate": "2025-11-12T11:19:40.9241373Z",
"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>fc48ddba-cd4b-490e-b115-875caadeeada</EndpointId>
<Expired>false</Expired>
<FirstSeen>2025-06-26T11:19:40.9241373Z</FirstSeen>
<FriendlyPCName></FriendlyPCName>
<GroupId>54b59cfa-3526-48d4-b99c-99963b5fc746</GroupId>
<GroupName>Test Group</GroupName>
<HostName>MyComputer1</HostName>
<InfectedNow>false</InfectedNow>
<InternalIP>10.213.47.211</InternalIP>
<IsolationStatus>UNISOLATED</IsolationStatus>
<LastChangesUserId>af63f4d4-d7fc-4c5b-8ddf-319fa2f023cb</LastChangesUserId>
<LastInfected>2025-08-26T11:19:40.9241373Z</LastInfected>
<LastPublicIP>95.97.179.50</LastPublicIP>
<LastScanSeq>38392609</LastScanSeq>
<LastSeen>2025-06-26T11:19:40.9241373Z</LastSeen>
<LicenseKey>3721-A291-E81E-47A9-BA79</LicenseKey>
<MACAddress>16-52-7E-66-1B-53</MACAddress>
<Mac>false</Mac>
<MachineId>1E082AB4D21647248F9FB01B30FFD9AA:::8B011CB707C94092B1B7D09E8773CD23:::8B011CB707C94092B1B7D09E8773CD23</MachineId>
<MaxUsers>2</MaxUsers>
<ModifiedDate>2025-11-19T11:19:40.9241373Z</ModifiedDate>
<NumUsers>1</NumUsers>
<PolicyId>30f9add0-8925-4bc2-86af-d96d4be9e86b</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>ba94d242-8254-4611-88a3-5c9532a45881</EndpointId>
<Expired>false</Expired>
<FirstSeen>2025-01-26T11:19:40.9241373Z</FirstSeen>
<FriendlyPCName></FriendlyPCName>
<GroupId>8ad5b4b8-fe4d-49d7-b6ee-9e6baf5910f6</GroupId>
<GroupName>Test Group</GroupName>
<HostName>MyComputer2</HostName>
<InfectedNow>false</InfectedNow>
<InternalIP>10.6.11.77</InternalIP>
<IsolationStatus>UNISOLATED</IsolationStatus>
<LastChangesUserId>57615704-44a0-44f4-9be2-f6004a88802a</LastChangesUserId>
<LastInfected>2025-05-26T11:19:40.9241373Z</LastInfected>
<LastPublicIP>95.40.136.97</LastPublicIP>
<LastScanSeq>251317016</LastScanSeq>
<LastSeen>2025-01-26T11:19:40.9241373Z</LastSeen>
<LicenseKey>3721-A291-E81E-47A9-BA79</LicenseKey>
<MACAddress>53-E2-E4-EA-29-2B</MACAddress>
<Mac>false</Mac>
<MachineId>0E0C71AA0BF646B8B8BE07D62E5ACDE9:::EAE39EEFA79A4F18876320DE289F71C7:::EAE39EEFA79A4F18876320DE289F71C7</MachineId>
<MaxUsers>4</MaxUsers>
<ModifiedDate>2025-11-12T11:19:40.9241373Z</ModifiedDate>
<NumUsers>1</NumUsers>
<PolicyId>4638229e-0e6e-4070-9dba-44bbd598097c</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>