Skip to main content
GET
Get Lead

Headers

Authorization
string
required

Bearer [access_token]

Path Parameters

leadId
integer<int64>
required

ID of the lead to retrieve.

Required range: x >= 1

Query Parameters

withTrash
boolean
default:false

When true, include trashed leads in the lookup.

Response

Lead retrieved successfully.

cannotText
boolean

false: can send message to the lead

cannotCall
boolean

false: can call to the lead

cannotEmail
boolean

false: can email to the lead

leadId
integer<int64>

The Id of the lead

leadUserId
integer<int64>

The user Id of the lead

firstName
string

The first/given name of the lead

lastName
string

The last/family name of the lead

birthday
string

The birthday of the lead

emails
string[]

The email list of the lead

Example:
phones
string[]

The phone list of the lead

Example:
leadSource
integer<int32>

The leadSource(Id) about the lead

source
string

The source of the lead

stageId
integer<int64>

The stageId of the lead

stage
string

The stage of the lead

assignedUserId
integer<int64>

The user Id of the lead assigned to

assignedUser
string

The Username of the lead assigned to

lenderUserId
integer<int64>

The user Id of the lead's lender

score
integer<int32>

The score of the lead

tags
object[]

The tags of the lead

teamId
integer<int64>

The teamId of the lead's team

streetAddress
string
deprecated

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

city
string
deprecated

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

state
string
deprecated

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

zipCode
string
deprecated

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

createTime
string

The create time of the lead

assignTime
string

The assigned time of the lead

facebook
string

The Facebook account of the lead

twitter
string

The Twitter account of the lead

hiddenFlag
boolean

The lead is hidden or not

referredBy
string

The referee of the lead

leadInquiry
object

LeadInquirys

leadPropertyList
object[]

LeadPropertyList

customAttributes
object[]

User customized field

lastUpdateTime
string

The update time of the lead

groups
string[]
deprecated

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

Example:
segments
string[]

The segments that the lead in

Example:
unsubscription
boolean

Unsubscription the email

leadTypes
integer<int32>[]

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

Example:
lastTouch
string

The last touch time of the lead

lastVisit
string

The last visit time of the lead

phoneStatuses
integer<int32>[]

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

Example:
assignCompletionStatus
boolean

Whether complete all lead assign process

buyingTimeFrame
string

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

Example:

"6-12"

preQual
string

Pre-qual, Yes or No

Example:

"Yes"

houseToSell
string

House to Sell, Yes or No

Example:

"Yes"

fthb
string

first time home buyer, Yes or No

Example:

"Yes"

withBuyerAgent
string

With buyer Agent, Yes or No

Example:

"Yes"

sellingTimeFrame
string

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

Example:

"1-3"

mortgage
string

Mortgage, Yes or No.

Example:

"Yes"

buyHouse
string

Buy a house, Yes or No.

Example:

"Yes"

withListingAgent
string

With listing agent, Yes or No.

Example:

"Yes"

opportunity
enum<string>

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.

Available options:
High Interest,
Sell,
Back to Site,
Back on Market
Example:

"High Interest"

leadFamilyMemberList
object[]

A list of family members associated with the lead

pondId
integer<int64>

The Id of the lead's pond

pondName
string

The Name of the lead's pond

customRoleList
object[]
language
string

The language of the lead

ownershipId
integer<int64>

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.

ownershipScope
string

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.