PullCustomerByKey

Pulls a customer by API CustomerKey.
Request Information

Parameters

Name	Description	Type	Additional information
customerKey		string	Required
Response Information

Resource Description

Customer
Name	Description	Type	Additional information
CustomerKey		string
CustomerId		string
Attributes		CustomerAttributes
Placement		SourcePlacement
Sample Response

<Customer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.BaseApi">
  <Placement>
    <GroupId>4</GroupId>
    <GroupName>sample string 5</GroupName>
    <EnvironmentId>3</EnvironmentId>
    <EnvironmentType>Undefined</EnvironmentType>
    <DealerId>2</DealerId>
    <SourceId>1</SourceId>
  </Placement>
  <Attributes xmlns:d2p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models.Customers">
    <d2p1:AllowsEmailContact>true</d2p1:AllowsEmailContact>
    <d2p1:AllowsMailContact>true</d2p1:AllowsMailContact>
    <d2p1:AllowsPhoneContact>true</d2p1:AllowsPhoneContact>
    <d2p1:AllowsSmsContact>true</d2p1:AllowsSmsContact>
    <d2p1:Comments>sample string 7</d2p1:Comments>
    <d2p1:ContactMethodType>sample string 15</d2p1:ContactMethodType>
    <d2p1:CustomerNumber>sample string 11</d2p1:CustomerNumber>
    <d2p1:CustomerType>sample string 12</d2p1:CustomerType>
    <d2p1:DriverLicenseNumber>sample string 8</d2p1:DriverLicenseNumber>
    <d2p1:DriverLicenseState>None</d2p1:DriverLicenseState>
    <d2p1:Identity xmlns:d3p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 3</d3p1:Address2>
      <d3p1:BirthDate>2025-04-28T13:36:51.6160321Z</d3p1:BirthDate>
      <d3p1:City>sample string 6</d3p1:City>
      <d3p1:CitySubDivisionName>sample string 20</d3p1:CitySubDivisionName>
      <d3p1:Country>sample string 16</d3p1:Country>
      <d3p1:County>sample string 14</d3p1:County>
      <d3p1:EmailAddress>sample string 12</d3p1:EmailAddress>
      <d3p1:PersonalName>
        <d3p1:FirstName>sample string 1</d3p1:FirstName>
        <d3p1:LastName>sample string 2</d3p1:LastName>
        <d3p1:MiddleName>sample string 3</d3p1:MiddleName>
        <d3p1:SingularName>sample string 4</d3p1:SingularName>
        <d3p1:Suffix>sample string 5</d3p1:Suffix>
        <d3p1:Title>None</d3p1:Title>
      </d3p1:PersonalName>
      <d3p1:PhoneNumbers>
        <d3p1:PhoneNumber>
          <d3p1:Digits>sample string 1</d3p1:Digits>
          <d3p1:NumberType>Unknown</d3p1:NumberType>
        </d3p1:PhoneNumber>
        <d3p1:PhoneNumber>
          <d3p1:Digits>sample string 1</d3p1:Digits>
          <d3p1:NumberType>Unknown</d3p1:NumberType>
        </d3p1:PhoneNumber>
      </d3p1:PhoneNumbers>
      <d3p1:Sex>Unknown</d3p1:Sex>
      <d3p1:SpouseAddress1>sample string 2</d3p1:SpouseAddress1>
      <d3p1:SpouseAddress2>sample string 4</d3p1:SpouseAddress2>
      <d3p1:SpouseBirthDate>2025-04-28T13:36:51.6160321Z</d3p1:SpouseBirthDate>
      <d3p1:SpouseCity>sample string 9</d3p1:SpouseCity>
      <d3p1:SpouseCountry>sample string 17</d3p1:SpouseCountry>
      <d3p1:SpouseCounty>sample string 15</d3p1:SpouseCounty>
      <d3p1:SpouseEmailAddress>sample string 13</d3p1:SpouseEmailAddress>
      <d3p1:SpouseName>
        <d3p1:FirstName>sample string 1</d3p1:FirstName>
        <d3p1:LastName>sample string 2</d3p1:LastName>
        <d3p1:MiddleName>sample string 3</d3p1:MiddleName>
        <d3p1:SingularName>sample string 4</d3p1:SingularName>
        <d3p1:Suffix>sample string 5</d3p1:Suffix>
        <d3p1:Title>None</d3p1:Title>
      </d3p1:SpouseName>
      <d3p1:SpousePhoneNumbers>
        <d3p1:PhoneNumber>
          <d3p1:Digits>sample string 1</d3p1:Digits>
          <d3p1:NumberType>Unknown</d3p1:NumberType>
        </d3p1:PhoneNumber>
        <d3p1:PhoneNumber>
          <d3p1:Digits>sample string 1</d3p1:Digits>
          <d3p1:NumberType>Unknown</d3p1:NumberType>
        </d3p1:PhoneNumber>
      </d3p1:SpousePhoneNumbers>
      <d3p1:SpouseSex>Unknown</d3p1:SpouseSex>
      <d3p1:SpouseSsn>sample string 19</d3p1:SpouseSsn>
      <d3p1:SpouseState>sample string 10</d3p1:SpouseState>
      <d3p1:SpouseZip>sample string 11</d3p1:SpouseZip>
      <d3p1:Ssn>sample string 18</d3p1:Ssn>
      <d3p1:State>sample string 7</d3p1:State>
      <d3p1:Title>sample string 5</d3p1:Title>
      <d3p1:Zip>sample string 8</d3p1:Zip>
    </d2p1:Identity>
    <d2p1:IsDealerToDealer>true</d2p1:IsDealerToDealer>
    <d2p1:IsMarried>true</d2p1:IsMarried>
    <d2p1:IsWholesale>true</d2p1:IsWholesale>
    <d2p1:LastContactDate>2025-04-28T13:36:51.6160321Z</d2p1:LastContactDate>
    <d2p1:ModifiedStamp>2025-04-28T13:36:51.6160321Z</d2p1:ModifiedStamp>
    <d2p1:OwnershipEndDate>2025-04-28T13:36:51.6160321Z</d2p1:OwnershipEndDate>
    <d2p1:PreferredPhoneNumber>sample string 14</d2p1:PreferredPhoneNumber>
    <d2p1:SpouseName>sample string 2</d2p1:SpouseName>
  </Attributes>
  <CustomerId>sample string 2</CustomerId>
  <CustomerKey>sample string 1</CustomerKey>
</Customer>