GET v2/Customers?IncludeSelf={IncludeSelf}&Recurse={Recurse}&ExternalReferenceKey={ExternalReferenceKey}

Returns all child customers of the requesting user's customer. Use the

Request Information

URI Parameters

Name	Description	Type	Additional information
IncludeSelf	If true the caller's customer will be included in the results.	boolean	None.
Recurse	If true the full tree of child customers will be returned. Otherwise only the 1st descendants will be returned.	boolean	None.
ExternalReferenceKey	When provided will filter the list of returned customers to those with a matching external reference key.	string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of Lhp.EquipmentIntelligence.WebApi.Client.Models.Customer

Name	Description	Type	Additional information
CustomerId	The customer ID	integer	None.
ParentCustomerId	The parent customer ID	integer	None.
CustomerTypeId	The customer type	integer	None.
Name	The customer name	string	None.
AddressStreet	Gets or sets the address street.	string	None.
AddressCity	Gets or sets the address city.	string	None.
AddressStateId	Gets or sets the address state identifier.	string	None.
AddressStateProvince	Gets or sets the address state province.	string	None.
AddressPostalCode	Gets or sets the address postal code.	string	None.
AddressCountryId	Gets or sets the address country identifier.	string	None.
MainContactName	Gets or sets the name of the main contact.	string	None.
MainContactPhone	Gets or sets the main contact phone.	string	None.
MainContactFax	Gets or sets the main contact fax.	string	None.
MainContactEmail	Gets or sets the main contact email.	string	None.
ExternalReferenceKey	Reference key used by external agency to identify the customer.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CustomerId": 1,
    "ParentCustomerId": 1,
    "CustomerTypeId": 2,
    "Name": "sample string 3",
    "AddressStreet": "sample string 4",
    "AddressCity": "sample string 5",
    "AddressStateId": "sample string 6",
    "AddressStateProvince": "sample string 7",
    "AddressPostalCode": "sample string 8",
    "AddressCountryId": "sample string 9",
    "MainContactName": "sample string 10",
    "MainContactPhone": "sample string 11",
    "MainContactFax": "sample string 12",
    "MainContactEmail": "sample string 13",
    "ExternalReferenceKey": "sample string 14"
  },
  {
    "CustomerId": 1,
    "ParentCustomerId": 1,
    "CustomerTypeId": 2,
    "Name": "sample string 3",
    "AddressStreet": "sample string 4",
    "AddressCity": "sample string 5",
    "AddressStateId": "sample string 6",
    "AddressStateProvince": "sample string 7",
    "AddressPostalCode": "sample string 8",
    "AddressCountryId": "sample string 9",
    "MainContactName": "sample string 10",
    "MainContactPhone": "sample string 11",
    "MainContactFax": "sample string 12",
    "MainContactEmail": "sample string 13",
    "ExternalReferenceKey": "sample string 14"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomer xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Customer>
    <CustomerId>1</CustomerId>
    <ParentCustomerId>1</ParentCustomerId>
    <CustomerTypeId>2</CustomerTypeId>
    <Name>sample string 3</Name>
    <AddressStreet>sample string 4</AddressStreet>
    <AddressCity>sample string 5</AddressCity>
    <AddressStateId>sample string 6</AddressStateId>
    <AddressStateProvince>sample string 7</AddressStateProvince>
    <AddressPostalCode>sample string 8</AddressPostalCode>
    <AddressCountryId>sample string 9</AddressCountryId>
    <MainContactName>sample string 10</MainContactName>
    <MainContactPhone>sample string 11</MainContactPhone>
    <MainContactFax>sample string 12</MainContactFax>
    <MainContactEmail>sample string 13</MainContactEmail>
    <ExternalReferenceKey>sample string 14</ExternalReferenceKey>
  </Customer>
  <Customer>
    <CustomerId>1</CustomerId>
    <ParentCustomerId>1</ParentCustomerId>
    <CustomerTypeId>2</CustomerTypeId>
    <Name>sample string 3</Name>
    <AddressStreet>sample string 4</AddressStreet>
    <AddressCity>sample string 5</AddressCity>
    <AddressStateId>sample string 6</AddressStateId>
    <AddressStateProvince>sample string 7</AddressStateProvince>
    <AddressPostalCode>sample string 8</AddressPostalCode>
    <AddressCountryId>sample string 9</AddressCountryId>
    <MainContactName>sample string 10</MainContactName>
    <MainContactPhone>sample string 11</MainContactPhone>
    <MainContactFax>sample string 12</MainContactFax>
    <MainContactEmail>sample string 13</MainContactEmail>
    <ExternalReferenceKey>sample string 14</ExternalReferenceKey>
  </Customer>
</ArrayOfCustomer>