GET /service/api/securecloud/customers/{customerId}

Provides information about an end customer.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
customerId

Identifier used to query information about an end customer.

string

Required

URI Sample(s)

GET
https://unityapi.webrootcloudav.com/service/api/securecloud/customers/1e0a7a3c-92b7-480d-a48f-a38600f660bf

Body Parameters

None.

Response Information

Resource Description

Information about an end customer.

GetCustomerResponseModel
NameDescriptionTypeAdditional Information
CustomerId

Unique guid of the customer.

string

None.

CustomerNumber

Unique number associated with the customer.

string

None.

Currency

Currency code selected by the customer.

string

None.

CustomerSince

Timestamp indicating when the customer was created in OpenText Secure Cloud.

date

None.

IsClosed

Indicates whether the customer's account is closed.

boolean

None.

Name

Name of the customer.

string

None.

CustomerType

Type of the customer. For example: Resold, Direct, Partner, Referred.

string

None.

AddressLine1

Part one of the street address.

string

None.

AddressLine2

Part two of the street address that indicates a suite, floor, or specific location.

string

None.

StateOrProvince

State or province of the customer.

string

None.

Country

Country code of the customer.

string

None.

Municipality

Municipality of the customer location.

string

None.

PostalCode

Postal code of the customer's location.

string

None.

Website

Customer's domain/website URI.

string

None.

Industry

Customer's industry sector. For example: Accounting, Banking etc.

string

None.

Culture

Desired language for UI and reports. For example: en-US, es-ES, de-DE.

string

None.

TimeZone

Timezone of the customer.

string

None.

ExternalCustomerAccountNumber

Identifier of the customer in systems external to OpenText Secure Cloud.

string

None.

AutoConvertTrials

Indicates whether to automatically convert trial subscriptions to paid ones when they expire. Valid values are true, false.

boolean

None.

Sample Response

{
  "CustomerId": "1e0a7a3c-92b7-480d-a48f-a38600f660bf",
  "CustomerNumber": "500021",
  "Currency": "USD",
  "CustomerSince": "2025-04-19T01:33:45.2505649Z",
  "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
}                    
<GetCustomerResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.SecureCloud.Models">
  <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>1e0a7a3c-92b7-480d-a48f-a38600f660bf</CustomerId>
  <CustomerNumber>500021</CustomerNumber>
  <CustomerSince>2025-04-19T01:33:45.2505649Z</CustomerSince>
  <IsClosed>false</IsClosed>
</GetCustomerResponseModel>