POST api/CRM/SearchCRMLeads?DealershipID={DealershipID}&PageSize={PageSize}&StartIndex={StartIndex}

Gets searched CRM Leads.

Request Information

URI Parameters

Name	Type	Additional information
DealershipID	integer	Required
PageSize	integer	Required
StartIndex	integer	Required

Body Parameters

CRMSearchFilter

Name	Type	Additional information
DateRange	string	None.
DateRangeFrom	date	None.
DateRangeTo	date	None.
DealershipID	integer	None.
StockNumber	string	None.
VIN	string	None.
ModelYear	integer	None.
MakeID	integer	None.
ModelID	integer	None.
Customer	string	None.
CustomerID	integer	None.
City	string	None.
State	string	None.
ZipCode	string	None.
AssignedToID	integer	None.
AssignedGroupID	integer	None.
UserID	integer	None.
TypeID	CrmTypeEnum	None.
Phone	string	None.
EmailAddress	string	None.
StatusID	byte	None.
TemperatureID	byte	None.
SortBy	CRMSortOrderEnum	None.
SortOrder	SortOrderEnum	None.
pagedFilter	PagedFilter	None.
CRMLeadAccess	boolean	None.
LeadSourceID	integer	None.
SoldAtID	integer	None.
IsShowroom	boolean	None.
IsBadLeads	boolean	None.
EmailOrPhoneSearch	boolean	None.
LocationID	integer	None.
ReplyBy	ReplyByEnum	None.

Request Formats

application/json, text/json

Sample:

{
  "DateRange": "sample string 1",
  "DateRangeFrom": "2025-05-11T12:50:21.6275285-04:00",
  "DateRangeTo": "2025-05-11T12:50:21.6275285-04:00",
  "DealershipID": 2,
  "StockNumber": "sample string 3",
  "VIN": "sample string 4",
  "ModelYear": 1,
  "MakeID": 1,
  "ModelID": 1,
  "Customer": "sample string 5",
  "CustomerID": 1,
  "City": "sample string 6",
  "State": "sample string 7",
  "ZipCode": "sample string 8",
  "AssignedToID": 1,
  "AssignedGroupID": 1,
  "UserID": 1,
  "TypeID": 0,
  "Phone": "sample string 9",
  "EmailAddress": "sample string 10",
  "StatusID": 64,
  "TemperatureID": 64,
  "SortBy": 0,
  "SortOrder": 0,
  "pagedFilter": {
    "PageSize": 10,
    "TotalPages": 1,
    "PageNo": 2
  },
  "CRMLeadAccess": true,
  "LeadSourceID": 1,
  "SoldAtID": 1,
  "IsShowroom": true,
  "IsBadLeads": true,
  "EmailOrPhoneSearch": true,
  "LocationID": 1,
  "ReplyBy": 1
}

application/xml, text/xml

Sample:

<CRMSearchFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DC.Core.Model">
  <AssignedGroupID>1</AssignedGroupID>
  <AssignedToID>1</AssignedToID>
  <CRMLeadAccess>true</CRMLeadAccess>
  <City>sample string 6</City>
  <Customer>sample string 5</Customer>
  <CustomerID>1</CustomerID>
  <DateRange>sample string 1</DateRange>
  <DateRangeFrom>2025-05-11T12:50:21.6275285-04:00</DateRangeFrom>
  <DateRangeTo>2025-05-11T12:50:21.6275285-04:00</DateRangeTo>
  <DealershipID>2</DealershipID>
  <EmailAddress>sample string 10</EmailAddress>
  <EmailOrPhoneSearch>true</EmailOrPhoneSearch>
  <IsBadLeads>true</IsBadLeads>
  <IsShowroom>true</IsShowroom>
  <LeadSourceID>1</LeadSourceID>
  <LocationID>1</LocationID>
  <MakeID>1</MakeID>
  <ModelID>1</ModelID>
  <ModelYear>1</ModelYear>
  <Phone>sample string 9</Phone>
  <ReplyBy>Email</ReplyBy>
  <SoldAtID>1</SoldAtID>
  <SortBy>LastUpdatedDate</SortBy>
  <SortOrder>Descending</SortOrder>
  <State>sample string 7</State>
  <StatusID>64</StatusID>
  <StockNumber>sample string 3</StockNumber>
  <TemperatureID>64</TemperatureID>
  <TypeID>CreditApplication</TypeID>
  <UserID>1</UserID>
  <VIN>sample string 4</VIN>
  <ZipCode>sample string 8</ZipCode>
  <pagedFilter>
    <PageNo>2</PageNo>
    <PageSize>P10</PageSize>
    <TotalPages>1</TotalPages>
  </pagedFilter>
</CRMSearchFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CRMSearchResultDTO

Name	Description	Type	Additional information
RecordCount		integer	None.
Listing		Collection of CRMListingDTO	None.

Response Formats

application/json, text/json

Sample:

{
  "RecordCount": 1,
  "Listing": [
    {
      "CustomerID": 1,
      "CustomerName": "sample string 2",
      "LeadDate": "2025-05-11T12:50:21.6275285-04:00",
      "LeadDateText": "5/11/2025",
      "Age": 0,
      "ModelYear": 1,
      "Make": "sample string 4",
      "MakeID": 1,
      "Model": "sample string 5",
      "ModelID": 1,
      "VehicleID": 6,
      "UserID": 7,
      "LeadID": 1,
      "LeadTypeID": 64,
      "SourceName": "sample string 9",
      "StatusID": 64,
      "DealershipID": 11,
      "StatusDescription": "sample string 12",
      "LeadSourceID": 13,
      "LeadSourceName": "sample string 14",
      "AssignedToID": 15,
      "AssignedToName": "sample string 16",
      "LeadTypeName": "64",
      "InteractionTypeID": 17,
      "LastUpdatedOn": "2025-05-11T12:50:21.6275285-04:00",
      "LastUpdatedOnText": "05/11/2025 12:50 PM",
      "TemperatureID": 64,
      "CoApplicantName": "sample string 19",
      "CoBuyerName": "|sample string 19",
      "CreditApplicationID": 20,
      "AppraisalRequestID": 21,
      "VehicleLeadID": 22,
      "DateAdded": "2025-05-11T12:50:21.6275285-04:00",
      "ReminderDate": "2025-05-11T12:50:21.6275285-04:00",
      "ReminderDateText": "05/11/2025 12:50 PM",
      "Memo": "sample string 23",
      "Phone": "sample string 24",
      "EmailAddress": "sample string 25",
      "ApplyCode": true,
      "ColorCode": "sample string 27",
      "ApplyColor": true,
      "TaskStatus": "sample string 28",
      "TaskDate": "2025-05-11T12:50:21.6275285-04:00",
      "TaskDateOnly": "05/11/2025",
      "TaskType": "sample string 30",
      "TaskID": 31,
      "DealershipName": "sample string 32",
      "IsSpam": true,
      "LeadMessage": "sample string 34"
    },
    {
      "CustomerID": 1,
      "CustomerName": "sample string 2",
      "LeadDate": "2025-05-11T12:50:21.6275285-04:00",
      "LeadDateText": "5/11/2025",
      "Age": 0,
      "ModelYear": 1,
      "Make": "sample string 4",
      "MakeID": 1,
      "Model": "sample string 5",
      "ModelID": 1,
      "VehicleID": 6,
      "UserID": 7,
      "LeadID": 1,
      "LeadTypeID": 64,
      "SourceName": "sample string 9",
      "StatusID": 64,
      "DealershipID": 11,
      "StatusDescription": "sample string 12",
      "LeadSourceID": 13,
      "LeadSourceName": "sample string 14",
      "AssignedToID": 15,
      "AssignedToName": "sample string 16",
      "LeadTypeName": "64",
      "InteractionTypeID": 17,
      "LastUpdatedOn": "2025-05-11T12:50:21.6275285-04:00",
      "LastUpdatedOnText": "05/11/2025 12:50 PM",
      "TemperatureID": 64,
      "CoApplicantName": "sample string 19",
      "CoBuyerName": "|sample string 19",
      "CreditApplicationID": 20,
      "AppraisalRequestID": 21,
      "VehicleLeadID": 22,
      "DateAdded": "2025-05-11T12:50:21.6275285-04:00",
      "ReminderDate": "2025-05-11T12:50:21.6275285-04:00",
      "ReminderDateText": "05/11/2025 12:50 PM",
      "Memo": "sample string 23",
      "Phone": "sample string 24",
      "EmailAddress": "sample string 25",
      "ApplyCode": true,
      "ColorCode": "sample string 27",
      "ApplyColor": true,
      "TaskStatus": "sample string 28",
      "TaskDate": "2025-05-11T12:50:21.6275285-04:00",
      "TaskDateOnly": "05/11/2025",
      "TaskType": "sample string 30",
      "TaskID": 31,
      "DealershipName": "sample string 32",
      "IsSpam": true,
      "LeadMessage": "sample string 34"
    }
  ]
}

application/xml, text/xml

Sample:

<CRMSearchResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DC.Core.Model">
  <Listing>
    <CRMListingDTO>
      <ApplyCode>true</ApplyCode>
      <AppraisalRequestID>21</AppraisalRequestID>
      <AssignedToID>15</AssignedToID>
      <AssignedToName>sample string 16</AssignedToName>
      <CoApplicantName>sample string 19</CoApplicantName>
      <ColorCode>sample string 27</ColorCode>
      <CreditApplicationID>20</CreditApplicationID>
      <CustomerID>1</CustomerID>
      <CustomerName>sample string 2</CustomerName>
      <DateAdded>2025-05-11T12:50:21.6275285-04:00</DateAdded>
      <DealershipID>11</DealershipID>
      <DealershipName>sample string 32</DealershipName>
      <EmailAddress>sample string 25</EmailAddress>
      <InteractionTypeID>17</InteractionTypeID>
      <IsSpam>true</IsSpam>
      <LastUpdatedOn>2025-05-11T12:50:21.6275285-04:00</LastUpdatedOn>
      <LeadDate>2025-05-11T12:50:21.6275285-04:00</LeadDate>
      <LeadMessage>sample string 34</LeadMessage>
      <LeadSourceID>13</LeadSourceID>
      <LeadSourceName>sample string 14</LeadSourceName>
      <LeadTypeID>64</LeadTypeID>
      <Make>sample string 4</Make>
      <MakeID>1</MakeID>
      <Memo>sample string 23</Memo>
      <Model>sample string 5</Model>
      <ModelID>1</ModelID>
      <ModelYear>1</ModelYear>
      <Phone>sample string 24</Phone>
      <ReminderDate>2025-05-11T12:50:21.6275285-04:00</ReminderDate>
      <SourceName>sample string 9</SourceName>
      <StatusDescription>sample string 12</StatusDescription>
      <StatusID>64</StatusID>
      <TaskDate>2025-05-11T12:50:21.6275285-04:00</TaskDate>
      <TaskID>31</TaskID>
      <TaskStatus>sample string 28</TaskStatus>
      <TaskType>sample string 30</TaskType>
      <TemperatureID>64</TemperatureID>
      <UserID>7</UserID>
      <VehicleID>6</VehicleID>
      <VehicleLeadID>22</VehicleLeadID>
    </CRMListingDTO>
    <CRMListingDTO>
      <ApplyCode>true</ApplyCode>
      <AppraisalRequestID>21</AppraisalRequestID>
      <AssignedToID>15</AssignedToID>
      <AssignedToName>sample string 16</AssignedToName>
      <CoApplicantName>sample string 19</CoApplicantName>
      <ColorCode>sample string 27</ColorCode>
      <CreditApplicationID>20</CreditApplicationID>
      <CustomerID>1</CustomerID>
      <CustomerName>sample string 2</CustomerName>
      <DateAdded>2025-05-11T12:50:21.6275285-04:00</DateAdded>
      <DealershipID>11</DealershipID>
      <DealershipName>sample string 32</DealershipName>
      <EmailAddress>sample string 25</EmailAddress>
      <InteractionTypeID>17</InteractionTypeID>
      <IsSpam>true</IsSpam>
      <LastUpdatedOn>2025-05-11T12:50:21.6275285-04:00</LastUpdatedOn>
      <LeadDate>2025-05-11T12:50:21.6275285-04:00</LeadDate>
      <LeadMessage>sample string 34</LeadMessage>
      <LeadSourceID>13</LeadSourceID>
      <LeadSourceName>sample string 14</LeadSourceName>
      <LeadTypeID>64</LeadTypeID>
      <Make>sample string 4</Make>
      <MakeID>1</MakeID>
      <Memo>sample string 23</Memo>
      <Model>sample string 5</Model>
      <ModelID>1</ModelID>
      <ModelYear>1</ModelYear>
      <Phone>sample string 24</Phone>
      <ReminderDate>2025-05-11T12:50:21.6275285-04:00</ReminderDate>
      <SourceName>sample string 9</SourceName>
      <StatusDescription>sample string 12</StatusDescription>
      <StatusID>64</StatusID>
      <TaskDate>2025-05-11T12:50:21.6275285-04:00</TaskDate>
      <TaskID>31</TaskID>
      <TaskStatus>sample string 28</TaskStatus>
      <TaskType>sample string 30</TaskType>
      <TemperatureID>64</TemperatureID>
      <UserID>7</UserID>
      <VehicleID>6</VehicleID>
      <VehicleLeadID>22</VehicleLeadID>
    </CRMListingDTO>
  </Listing>
  <RecordCount>1</RecordCount>
</CRMSearchResultDTO>