GET Api/Lead/DetailByPhone?phoneNumber={phoneNumber}&leadId={leadId}&crn={crn}

Request Information

URI Parameters

Name	Type	Additional information
phoneNumber	string	None.
leadId	string	None.
crn	string	None.

Body Parameters

None.

Response Information

Resource Description

ResultOfPhoneLeadSearchResult

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
ErrorMessage	Collection of string	None.
Value	PhoneLeadSearchResult	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Value": {
    "SolarLeads": [
      {
        "SolarLeadId": "sample string 1",
        "SolarLeadSubmitted": "2025-12-07T00:16:07.4859417+00:00"
      },
      {
        "SolarLeadId": "sample string 1",
        "SolarLeadSubmitted": "2025-12-07T00:16:07.4859417+00:00"
      }
    ],
    "HealthLeads": [
      {
        "HealthLeadId": "sample string 1",
        "HealthLeadSubmitted": "2025-12-07T00:16:07.4859417+00:00"
      },
      {
        "HealthLeadId": "sample string 1",
        "HealthLeadSubmitted": "2025-12-07T00:16:07.4859417+00:00"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ResultOfPhoneLeadSearchResultVHDxlVkh xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Common.Returns">
  <ErrorMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorMessage>
  <Message>sample string 2</Message>
  <Success>true</Success>
  <Value xmlns:d2p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Master.Objects">
    <d2p1:HealthLeads>
      <d2p1:HealthLeadResult>
        <d2p1:HealthLeadId>sample string 1</d2p1:HealthLeadId>
        <d2p1:HealthLeadSubmitted>2025-12-07T00:16:07.4859417+00:00</d2p1:HealthLeadSubmitted>
      </d2p1:HealthLeadResult>
      <d2p1:HealthLeadResult>
        <d2p1:HealthLeadId>sample string 1</d2p1:HealthLeadId>
        <d2p1:HealthLeadSubmitted>2025-12-07T00:16:07.4859417+00:00</d2p1:HealthLeadSubmitted>
      </d2p1:HealthLeadResult>
    </d2p1:HealthLeads>
    <d2p1:SolarLeads>
      <d2p1:SolarLeadResult>
        <d2p1:SolarLeadId>sample string 1</d2p1:SolarLeadId>
        <d2p1:SolarLeadSubmitted>2025-12-07T00:16:07.4859417+00:00</d2p1:SolarLeadSubmitted>
      </d2p1:SolarLeadResult>
      <d2p1:SolarLeadResult>
        <d2p1:SolarLeadId>sample string 1</d2p1:SolarLeadId>
        <d2p1:SolarLeadSubmitted>2025-12-07T00:16:07.4859417+00:00</d2p1:SolarLeadSubmitted>
      </d2p1:SolarLeadResult>
    </d2p1:SolarLeads>
  </Value>
</ResultOfPhoneLeadSearchResultVHDxlVkh>