GET /service/api/securecloud/customers
?limit={limit}
&offset={offset}
&includeClosedCustomers={includeClosedCustomers}
Provides a paginated list of all end customers, with only active customers included by default. Optionally includes closed customers based on the provided parameters.
Request Information
URI Parameters
Name | Description | Type | Additional Information |
---|---|---|---|
limit |
The maximum number of records to return. Valid values are between 10 and 1000. |
integer |
None. |
offset |
Specifies the number of records to skip, determining the starting point for displaying results. The record index starts from zero. |
integer |
None. |
includeClosedCustomers |
Specifies whether to include closed customers in the results. Set to true to include closed customers; otherwise, only active customers are returned. |
boolean |
Default value is False |
URI Sample(s)
GET
|
https://unityapi.webrootcloudav.com/service/api/securecloud/customers?limit=15&offset=0
|
GET
|
https://unityapi.webrootcloudav.com/service/api/securecloud/customers?limit=10
|
GET
|
https://unityapi.webrootcloudav.com/service/api/securecloud/customers?limit=15&offset=0&includeClosedCustomers=false
|
Body Parameters
None.
Response Information
Resource Description
List of end customers.
GetAllCustomersResponseModelName | Description | Type | Additional Information |
---|---|---|---|
Customers |
List of customer detail records. |
Collection of GetCustomerResponseModel |
None. |
Links |
Pagination information. |
GetAllCustomersResponseModelPageLinks |
None. |
Meta |
Additional information of the response. |
GetAllCustomersResponseModelPageMeta |
None. |
Sample Response
{ "Customers": [ { "CustomerId": "2bf3073f-5f72-4e72-9c3e-93cf4f1d85f0", "CustomerNumber": "500021", "Currency": "USD", "CustomerSince": "2025-05-19T08:14:27.3862375Z", "IsClosed": false, "Name": "Quixotic Quote", "CustomerType": "Resold", "AddressLine1": "1900 Sample Address Line", "AddressLine2": "", "StateOrProvince": "MS", "Country": "US", "Municipality": "FWB", "PostalCode": "32566", "Website": "http://quixotic-quote.test", "Industry": "Accounting", "Culture": "en-US", "TimeZone": "Central Standard Time", "ExternalCustomerAccountNumber": null, "AutoConvertTrials": true }, { "CustomerId": "c49d4571-52e5-4b2f-800c-9eb49c1fc489", "CustomerNumber": "500021", "Currency": "USD", "CustomerSince": "2025-05-19T08:14:27.3862375Z", "IsClosed": false, "Name": "Aston Technologies", "CustomerType": "Resold", "AddressLine1": "1900 St.marks street", "AddressLine2": "", "StateOrProvince": "MS", "Country": "US", "Municipality": "Cantonment", "PostalCode": "32533", "Website": "http://ashtontech.com", "Industry": "Education", "Culture": "en-US", "TimeZone": "Central Standard Time", "ExternalCustomerAccountNumber": null, "AutoConvertTrials": true } ], "Links": { "NextPageLimit": 84, "NextPageOffset": 85 }, "Meta": { "Page": { "Total": 473 } } }
<GetAllCustomersResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.SecureCloud.Models"> <Customers> <GetCustomerResponseModel> <AddressLine1>1900 Sample Address Line</AddressLine1> <AddressLine2></AddressLine2> <AutoConvertTrials>true</AutoConvertTrials> <Country>US</Country> <Culture>en-US</Culture> <CustomerType>Resold</CustomerType> <ExternalCustomerAccountNumber i:nil="true" /> <Industry>Accounting</Industry> <Municipality>FWB</Municipality> <Name>Quixotic Quote</Name> <PostalCode>32566</PostalCode> <StateOrProvince>MS</StateOrProvince> <TimeZone>Central Standard Time</TimeZone> <Website>http://quixotic-quote.test</Website> <Currency>USD</Currency> <CustomerId>2bf3073f-5f72-4e72-9c3e-93cf4f1d85f0</CustomerId> <CustomerNumber>500021</CustomerNumber> <CustomerSince>2025-05-19T08:14:27.3862375Z</CustomerSince> <IsClosed>false</IsClosed> </GetCustomerResponseModel> <GetCustomerResponseModel> <AddressLine1>1900 St.marks street</AddressLine1> <AddressLine2></AddressLine2> <AutoConvertTrials>true</AutoConvertTrials> <Country>US</Country> <Culture>en-US</Culture> <CustomerType>Resold</CustomerType> <ExternalCustomerAccountNumber i:nil="true" /> <Industry>Education</Industry> <Municipality>Cantonment</Municipality> <Name>Aston Technologies</Name> <PostalCode>32533</PostalCode> <StateOrProvince>MS</StateOrProvince> <TimeZone>Central Standard Time</TimeZone> <Website>http://ashtontech.com</Website> <Currency>USD</Currency> <CustomerId>c49d4571-52e5-4b2f-800c-9eb49c1fc489</CustomerId> <CustomerNumber>500021</CustomerNumber> <CustomerSince>2025-05-19T08:14:27.3862375Z</CustomerSince> <IsClosed>false</IsClosed> </GetCustomerResponseModel> </Customers> <Links> <NextPageLimit>84</NextPageLimit> <NextPageOffset>85</NextPageOffset> </Links> <Meta> <Page> <Total>473</Total> </Page> </Meta> </GetAllCustomersResponseModel>