PullCustomersByKey

Pulls customers by API CustomerKey.

Request Information

Parameters

Collection of string

Sample Request

<ArrayOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <string>sample string 1</string>
  <string>sample string 2</string>
</ArrayOfstring>

Response Information

Resource Description

Collection of Customer

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

Sample Response

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