v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB

Leads

Get Lead

Returns a single lead by ID. The response is wrapped under the 'lead' key.

Notes:

By default, trashed leads are not returned. Pass withTrash=true to include them.
Caller must have access to the lead; otherwise 404 LEAD_NOT_EXIST.

get/v1.0/leads/{leadId}

Path parameters

leadIdinteger required

ID of the lead to retrieve.

Query parameters

withTrashboolean

When true, include trashed leads in the lookup.

Headers

Authorizationstring required

Bearer [access_token]

Response

Lead retrieved successfully.

cannotTextboolean

false: can send message to the lead

cannotCallboolean

false: can call to the lead

cannotEmailboolean

false: can email to the lead

leadIdinteger

The Id of the lead

leadUserIdinteger

The user Id of the lead

firstNamestring

The first/given name of the lead

lastNamestring

The last/family name of the lead

birthdaystring

The birthday of the lead

emailsstring[]

The email list of the lead

phonesstring[]

The phone list of the lead

leadSourceinteger

The leadSource(Id) about the lead

sourcestring

The source of the lead

stageIdinteger

The stageId of the lead

stagestring

The stage of the lead

assignedUserIdinteger

The user Id of the lead assigned to

assignedUserstring

The Username of the lead assigned to

lenderUserIdinteger

The user Id of the lead's lender

scoreinteger

The score of the lead

teamIdinteger

The teamId of the lead's team

streetAddressstring

The streetAddress associated with the lead. Deprecated: please use the streetAddress field in leadPropertyList instead.

citystring

The city associated with the lead. Deprecated: please use the city field in leadPropertyList instead.

statestring

The state associated with the lead. Deprecated: please use the state field in leadPropertyList instead.

zipCodestring

The zip code associated with the lead. Deprecated: please use the zipCode field in leadPropertyList instead.

createTimestring

The create time of the lead

assignTimestring

The assigned time of the lead

facebookstring

The Facebook account of the lead

twitterstring

The Twitter account of the lead

hiddenFlagboolean

The lead is hidden or not

referredBystring

The referee of the lead

lastUpdateTimestring

The update time of the lead

groupsstring[]

The groups that the lead in. Deprecated, use segments instead.

segmentsstring[]

The segments that the lead in

unsubscriptionboolean

Unsubscription the email

leadTypesinteger[]

Types of lead, expressed by ID. Type ID : Other (-1), Seller (1), Buyer (2), Renter (5), Investor (6), Agent (7), Homeowner (8), Landlord (9)

lastTouchstring

The last touch time of the lead

lastVisitstring

The last visit time of the lead

phoneStatusesinteger[]

The status of the phone number Type id: invaild number(1), vaild number(2), talked(3), DNC Number(4), DNC Contact(5)

assignCompletionStatusboolean

Whether complete all lead assign process

buyingTimeFramestring

buying time frame, 1-3, 3-6, 6-12, 12+, Just Looking, Refinancing.

preQualstring

Pre-qual, Yes or No

houseToSellstring

House to Sell, Yes or No

fthbstring

first time home buyer, Yes or No

withBuyerAgentstring

With buyer Agent, Yes or No

sellingTimeFramestring

selling time frame, 1-3, 3-6, 6-12, 12+, Just Looking, Refinancing.

mortgagestring

Mortgage, Yes or No.

buyHousestring

Buy a house, Yes or No.

withListingAgentstring

With listing agent, Yes or No.

opportunity'High Interest' | 'Sell' | 'Back to Site' | 'Back on Market'

The lead's current opportunity type, derived from on-platform lead scoring. One of: "High Interest", "Sell", "Back to Site", "Back on Market". Null when the lead has no active opportunity.

pondIdinteger

The Id of the lead's pond

pondNamestring

The Name of the lead's pond

languagestring

The language of the lead

ownershipIdinteger

The entity ID associated with ownershipScope: the office ID when scope is OFFICE, or the agent's user ID when scope is PERSONAL. Not applicable when scope is TEAM.

ownershipScopestring

The visibility scope of the lead. TEAM — Account-wide: visible to all users in this Lofty client account. OFFICE — visible only within a specific office. PERSONAL — visible only to a single agent. Note: TEAM refers to the entire client account (the organization), not the Lofty "Team add-on" product.

Example response

{
  "emails": [
    "jane.doe@example.com",
    "jdoe-work@company.com"
  ],
  "phones": [
    "+14155551234",
    "+12125559876"
  ],
  "leadInquiry": {
    "priceMin": 1,
    "priceMax": 10000000,
    "propertyType": [
      "Single Family Home",
      "Condo"
    ],
    "bedroomsMin": 1,
    "bathroomsMin": "1",
    "locations": [
      {
        "city": "Austin",
        "stateCode": "TX"
      }
    ]
  },
  "leadPropertyList": [
    {
      "price": 100000,
      "state": "California",
      "city": "New York",
      "streetAddress": "22348 Regnart RD",
      "zipCode": "25401",
      "propertyType": "Single Family Home",
      "bedrooms": 3,
      "bathrooms": 2,
      "squareFeet": 100,
      "lotSize": 26.33,
      "parkingSpace": 1,
      "floors": 1,
      "priceMax": 10000000,
      "priceMin": 100000
    }
  ],
  "customAttributes": [
    {
      "attributeType": "number, text, date, anniversary_date, single_select, multi_select, percentage, currency"
    }
  ],
  "groups": [
    "VIP Clients",
    "Open House Feb"
  ],
  "segments": [
    "First-Time Buyers",
    "Downtown Area"
  ],
  "leadTypes": [
    2,
    5
  ],
  "phoneStatuses": [
    2,
    3
  ],
  "buyingTimeFrame": "6-12",
  "preQual": "Yes",
  "houseToSell": "Yes",
  "fthb": "Yes",
  "withBuyerAgent": "Yes",
  "sellingTimeFrame": "1-3",
  "mortgage": "Yes",
  "buyHouse": "Yes",
  "withListingAgent": "Yes",
  "opportunity": "High Interest",
  "leadFamilyMemberList": [
    {
      "phones": [
        "+14155551234"
      ],
      "emails": [
        "spouse@example.com"
      ]
    }
  ]
}