GET api/inboundlead/getlead/{id}

Gets a lead by its id Processes this inbound lead API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The id of the lead	integer	Required

Body Parameters

None.

Response Information

Resource Description

The response returned after the operation completes.

InboundLeadDataContract

Name	Description	Type	Additional information
BranchId	The unique identifier of the related branch resource.	integer	None.
People	The collection of people.	Collection of LeadPersonDataContract	None.
Email	The email value.	string	None.
DateSubmitted	The date submitted, expressed as a date and time.	date	None.
Address	The address value.	string	None.
Postcode	The postcode value.	string	None.
Country	The country value.	string	None.
PhonePrimary	The phone primary value.	string	None.
PhoneMobile	The phone mobile value.	string	None.
PhoneOther	The phone other value.	string	None.
DPAFlag	Indicates whether dpa flag is true.	boolean	None.
PropertyToSell	Indicates whether property to sell is true.	boolean	None.
PropertyToRent	Indicates whether property to rent is true.	boolean	None.
Comment	The comment value.	string	None.
FinancialAdvice	Indicates whether financial advice is true.	boolean	None.
PartExchange	Indicates whether part exchange is true.	boolean	None.
SourceType	The source type value.	EnumDataContract	None.
RequestType	The request type value.	EnumDataContract	None.
PropertyMarketingRoleIds	The unique identifiers of the related property marketing role resources.	Collection of integer	None.
PropertyDetails	The collection of property details.	Collection of LeadPropertyDetailDataContract	None.
Id	The unique identifier of this resource.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "BranchId": 1,
  "People": [
    {
      "Title": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3"
    },
    {
      "Title": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3"
    }
  ],
  "Email": "sample string 1",
  "DateSubmitted": "2026-07-23T08:19:29.593827Z",
  "Address": "sample string 3",
  "Postcode": "sample string 4",
  "Country": "sample string 5",
  "PhonePrimary": "sample string 6",
  "PhoneMobile": "sample string 7",
  "PhoneOther": "sample string 8",
  "DPAFlag": true,
  "PropertyToSell": true,
  "PropertyToRent": true,
  "Comment": "sample string 9",
  "FinancialAdvice": true,
  "PartExchange": true,
  "SourceType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "RequestType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "PropertyMarketingRoleIds": [
    1,
    2
  ],
  "PropertyDetails": [
    {
      "PropertyId": 1,
      "Price": {
        "PriceValue": 1.1,
        "CurrencyCode": "sample string 2",
        "PriceText": "sample string 3",
        "PriceType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "PriceQualifierType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Id": 4
      },
      "RoleStatus": "sample string 2",
      "UnderOffer": true,
      "OrganizationName": "sample string 4",
      "Number": "sample string 5",
      "BuildingName": "sample string 6",
      "Street": "sample string 7",
      "Town": "sample string 8",
      "Locality": "sample string 9",
      "County": "sample string 10",
      "Postcode": "sample string 11",
      "Id": 12
    },
    {
      "PropertyId": 1,
      "Price": {
        "PriceValue": 1.1,
        "CurrencyCode": "sample string 2",
        "PriceText": "sample string 3",
        "PriceType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "PriceQualifierType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Id": 4
      },
      "RoleStatus": "sample string 2",
      "UnderOffer": true,
      "OrganizationName": "sample string 4",
      "Number": "sample string 5",
      "BuildingName": "sample string 6",
      "Street": "sample string 7",
      "Town": "sample string 8",
      "Locality": "sample string 9",
      "County": "sample string 10",
      "Postcode": "sample string 11",
      "Id": 12
    }
  ],
  "Id": 10
}