Read

Read

Returns information for a single customer.

Request

Method
URL
POST
 https://api.solatech-dos.com/customers/v1/read 

Headers

Name
Required
Type
Description
APIKey
Guid
A valid API key with a scope of Customers | Read

Body

Property
Required
Type
Description
UniqueID
GUID
The unique ID of the customer.
ExternalID
Text
The external ID of the customer.
{
  "UniqueID": "0964b206-61e0-4fc0-a753-09a74eff7f64",
  "ExternalID": ""
}

Remarks

To identify a customer, only the UniqueID OR the ExternalID are used. If both are supplied, the UniqueID will be used.
Customer measure sheets and measurements are accessed by the Measurements API.
Customer history is not returned by the API.

Response

Headers

None

Status Code

Code
Description
200 OK
The customer was read.
400 Bad Request
The customer could not be read. The reason why will be returned.
401 Unauthorized
The API key is missing, invalid, disabled, or does not have the correct scope.

Body

All details, except the measure sheets and history, are returned. Refer to the body format when creating a customer for an explanation of the format.
{
	"uniqueID": "c24b6b54-319a-47dc-a482-37110569ac26",
	"externalID": "",
	"displayName": "Jack Black",
	"firstName": "Jack",
	"middleInitial": "",
	"lastName": "Black",
	"companyName": "",
	"accountNumber": "",
	"jobNumber": "12345",
	"active": true,
	"salesRep": "odiemckraken@solatech-darious.com",
	"installer": "",
	"terms": "",
	"leadSource": "Flyer",
	"appointmentType": "",
	"location": "",
	"discountGroup": "",
	"customerType": "",
	"alternateInstaller": "",
	"billToAddress1": "",
	"billToAddress2": "",
	"billToCity": "",
	"billToState": "",
	"billToZip": "",
	"billToCountry": "",
	"phones": [
		{
			"sequence": 1,
			"primary": true,
			"label": "Home",
			"number": "123-456-7890",
			"addedOn": "2025-08-20T17:20:27.317",
			"updatedOn": "2025-08-20T17:20:27.317"
		},
		{
			"sequence": 2,
			"primary": false,
			"label": "Work",
			"number": "800-123-4748",
			"addedOn": "2025-08-20T17:20:27.32",
			"updatedOn": "2025-08-20T17:20:27.32"
		}
	],
	"shippingAddresses": [
		{
			"sequence": 1,
			"primary": true,
			"label": "Home",
			"address1": "45 Main Street",
			"address2": "",
			"city": "High Point",
			"state": "NC",
			"zip": "27262",
			"country": "",
			"addedOn": "2025-08-20T17:20:27.303",
			"updatedOn": "2025-08-20T17:20:27.303"
		}
	],
	"attachments": [],
	"notes": [
		{
			"note": "Must call before heading to an appointment.",
			"addedOn": "2025-08-20T17:20:27.323",
			"updatedOn": "2025-08-20T17:20:27.323"
		},
		{
			"note": "Gate code is 12345.",
			"addedOn": "2025-08-20T17:20:27.327",
			"updatedOn": "2025-08-20T17:20:27.327"
		}
	],
	"links": [],
	"emailAddresses": [
		{
			"sequence": 1,
			"primary": true,
			"label": "Personal",
			"address": "jblack@gmail.com",
			"addedOn": "2025-08-20T17:20:27.313",
			"updatedOn": "2025-08-20T17:20:27.313"
		}
	],
	"tags": [
		{
			"tag": "Big-House",
			"addedOn": "2025-08-20T17:20:27.333"
		}
	],
	"taxExempt": false,
	"taxExemptReason": 0,
	"taxExemptDetails": "",
	"taxCodes": []
}