GET 17.0/app/contacts/{id}/summary

Description

Gets basic information for a Contact and their Property Requirements

URI Parameters
Name Description Type Additional information
id

ID of the Contact to retrieve a summary for

 integer

Required

None.

None.

A ContactSummaryResponse model

ContactSummary
Name Description Type Additional information
ID

integer

None.
Name

string

None.
EmailAddress

string

None.
EmailAddressAlt

string

None.
MobileNumber

string

None.
TelephoneNumber

string

None.
Address

string

None.
LastContacted

date

None.
Type

IDDescriptionWithColors

None.
Status

IDDescriptionWithColors

None.
SourceID

integer

None.
IsPrimaryContact

boolean

None.
IsLinkedContact

boolean

None.
LinkedTo

string

None.
MarketingPreferences

BasicMarketingPreferences

None.
PropertyRequirements

PropertyRequirementsSummary

None.

application/json, text/json
Sample: 
{
  "id": 1,
  "name": "sample string 2",
  "emailAddress": "sample string 3",
  "emailAddressAlt": "sample string 4",
  "mobileNumber": "sample string 5",
  "telephoneNumber": "sample string 6",
  "address": "sample string 7",
  "lastContacted": "2025-01-09T20:51",
  "type": {
    "foreColor": 1,
    "backColor": 2,
    "id": 3,
    "description": "sample string 4"
  },
  "status": {
    "foreColor": 1,
    "backColor": 2,
    "id": 3,
    "description": "sample string 4"
  },
  "sourceID": 8,
  "isPrimaryContact": true,
  "isLinkedContact": true,
  "linkedTo": "sample string 11",
  "marketingPreferences": {
    "email": true,
    "telephone": true,
    "smsText": true,
    "confirmed": true
  },
  "propertyRequirements": {
    "priceRange": "sample string 1",
    "bedrooms": "sample string 2",
    "category": {
      "id": 1,
      "description": "sample string 2"
    },
    "usage": {
      "id": 1,
      "description": "sample string 2"
    }
  }
}

application/xml, text/xml
Sample: 
<ContactSummary xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>1</ID>
  <Name>sample string 2</Name>
  <EmailAddress>sample string 3</EmailAddress>
  <EmailAddressAlt>sample string 4</EmailAddressAlt>
  <MobileNumber>sample string 5</MobileNumber>
  <TelephoneNumber>sample string 6</TelephoneNumber>
  <Address>sample string 7</Address>
  <LastContacted>2025-01-09T20:51:23.6011567+00:00</LastContacted>
  <Type>
    <ID>3</ID>
    <Description>sample string 4</Description>
    <ForeColor>1</ForeColor>
    <BackColor>2</BackColor>
  </Type>
  <Status>
    <ID>3</ID>
    <Description>sample string 4</Description>
    <ForeColor>1</ForeColor>
    <BackColor>2</BackColor>
  </Status>
  <SourceID>8</SourceID>
  <IsPrimaryContact>true</IsPrimaryContact>
  <IsLinkedContact>true</IsLinkedContact>
  <LinkedTo>sample string 11</LinkedTo>
  <MarketingPreferences>
    <Email>true</Email>
    <Telephone>true</Telephone>
    <SmsText>true</SmsText>
    <Confirmed>true</Confirmed>
  </MarketingPreferences>
  <PropertyRequirements>
    <PriceRange>sample string 1</PriceRange>
    <Bedrooms>sample string 2</Bedrooms>
    <Category>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Category>
    <Usage>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Usage>
  </PropertyRequirements>
</ContactSummary>