GetCustomersV3 | EnergyCAP Developer

Request Headers

Header	Value	Required	Description
ECI-ApiKey	string	Yes	Your API key. See Authentication.
Content-Type	application/json	Yes	All requests must specify JSON content type.

Query Parameters

Name	Description	Type	Required
filter		string (string)	Optional

Filters

Filter	Description	Type	Operators
customerInfo	Customer Name	String	equals not equals one of like not like not one of

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

Array of:

CustomerResponse

Property

Description

Type

address

AddressChild

AddressChild properties

Property	Description	Type
addressTypeId	The address type identifier	integer (int32)
city	The city of the place Must be between 0 and 100 characters	string
country	The country of the place Must be between 0 and 64 characters	string
latitude	The latitude of the place Required when the country is not United States or Canada Must be between -90 and 90 Required when Longitude is set	number (double)
line1	The line 1 of the address Must be between 0 and 100 characters	string
line2	The line 2 of the address Must be between 0 and 100 characters	string
line3	The line 3 of the address Must be between 0 and 100 characters	string
longitude	The longitude of the place Required when the country is not United States or Canada Must be between -180 and 180 Required when Latitude is set	number (double)
postalCode	The postal code of the place Must be between 0 and 32 characters	string
remitTo	Remit To field is the name of the person or company who should receive the payment. It’s required for bill pay customers. Must be between 0 and 100 characters	string
state	The state of the place Must be between 0 and 100 characters	string

customerCode

The customer code

string

customerId

The customer identifier

integer (int32)

customerInfo

The customer info