Task & Calendar
Transactions
Communication
Team
AI Copilot
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.
curl --request GET \
--url https://api.lofty.com/v1.0/leads/{leadId} \
--header 'Authorization: <authorization>'{
"cannotText": true,
"cannotCall": true,
"cannotEmail": true,
"leadId": 123,
"leadUserId": 123,
"firstName": "<string>",
"lastName": "<string>",
"birthday": "<string>",
"emails": [
"jane.doe@example.com",
"jdoe-work@company.com"
],
"phones": [
"+14155551234",
"+12125559876"
],
"leadSource": 123,
"source": "<string>",
"stageId": 123,
"stage": "<string>",
"assignedUserId": 123,
"assignedUser": "<string>",
"lenderUserId": 123,
"score": 123,
"tags": [
{
"leadId": 123,
"tagId": 123,
"createTime": "<string>",
"updateTime": "<string>",
"tagName": "<string>",
"creatorUserId": 123,
"visibleType": 123
}
],
"teamId": 123,
"streetAddress": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"createTime": "<string>",
"assignTime": "<string>",
"facebook": "<string>",
"twitter": "<string>",
"hiddenFlag": true,
"referredBy": "<string>",
"leadInquiry": {
"priceMin": 1,
"priceMax": 10000000,
"propertyType": [
"Single Family Home",
"Condo"
],
"bedroomsMin": 1,
"bathroomsMin": "1",
"locations": [
{
"city": "Austin",
"stateCode": "TX"
}
],
"id": 123,
"leadUserId": 123,
"bedroomsMax": 123,
"bathroomsMax": "<string>",
"modifyByAgent": true,
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z",
"defaultValue": true
},
"leadPropertyList": [
{
"price": 100000,
"state": "California",
"city": "New York",
"streetAddress": "22348 Regnart RD",
"zipCode": "25401",
"county": "<string>",
"propertyType": "Single Family Home",
"bedrooms": 3,
"bathrooms": 2,
"squareFeet": 100,
"lotSize": 26.33,
"parkingSpace": 1,
"floors": 1,
"mailAddress": true,
"id": 123,
"leadUserId": 123,
"listingId": "<string>",
"autoListingId": 123,
"label": "<string>",
"note": "<string>",
"listingStatus": "<string>",
"labelList": "<string>",
"pictureUrl": "<string>",
"siteListingUrl": "<string>",
"labelType": "<string>"
}
],
"customAttributes": [
{
"attributeName": "<string>",
"attributeType": "number, text, date, single_select, multi_select, percentage, currency",
"value": "<string>",
"params": "<string>"
}
],
"lastUpdateTime": "<string>",
"groups": [
"VIP Clients",
"Open House Feb"
],
"segments": [
"First-Time Buyers",
"Downtown Area"
],
"unsubscription": true,
"leadTypes": [
2,
5
],
"lastTouch": "<string>",
"lastVisit": "<string>",
"phoneStatuses": [
2,
3
],
"assignCompletionStatus": true,
"buyingTimeFrame": "6-12",
"preQual": "Yes",
"houseToSell": "Yes",
"fthb": "Yes",
"withBuyerAgent": "Yes",
"sellingTimeFrame": "1-3",
"mortgage": "Yes",
"buyHouse": "Yes",
"withListingAgent": "Yes",
"opportunity": "High Interest",
"leadFamilyMemberList": [
{
"firstName": "<string>",
"relationship": "<string>",
"lastName": "<string>",
"phones": [
"+14155551234"
],
"emails": [
"spouse@example.com"
],
"birthday": "<string>"
}
],
"pondId": 123,
"pondName": "<string>",
"customRoleList": [
{
"roleId": 123,
"role": "<string>",
"assigneeId": 123,
"assignee": "<string>"
}
],
"language": "<string>",
"ownershipId": 123,
"ownershipScope": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://developer.lofty.com/llms.txt
Use this file to discover all available pages before exploring further.
Headers
Bearer [access_token]
Path Parameters
ID of the lead to retrieve.
x >= 1Query Parameters
When true, include trashed leads in the lookup.
Response
Lead retrieved successfully.
false: can send message to the lead
false: can call to the lead
false: can email to the lead
The Id of the lead
The user Id of the lead
The first/given name of the lead
The last/family name of the lead
The birthday of the lead
The email list of the lead
[
"jane.doe@example.com",
"jdoe-work@company.com"
]The phone list of the lead
["+14155551234", "+12125559876"]The leadSource(Id) about the lead
The source of the lead
The stageId of the lead
The stage of the lead
The user Id of the lead assigned to
The Username of the lead assigned to
The user Id of the lead's lender
The score of the lead
The tags of the lead
Show child attributes
Show child attributes
The teamId of the lead's team
The streetAddress associated with the lead. Deprecated: please use the streetAddress field in leadPropertyList instead.
The city associated with the lead. Deprecated: please use the city field in leadPropertyList instead.
The state associated with the lead. Deprecated: please use the state field in leadPropertyList instead.
The zip code associated with the lead. Deprecated: please use the zipCode field in leadPropertyList instead.
The create time of the lead
The assigned time of the lead
The Facebook account of the lead
The Twitter account of the lead
The lead is hidden or not
The referee of the lead
LeadInquirys
Show child attributes
Show child attributes
LeadPropertyList
Show child attributes
Show child attributes
User customized field
Show child attributes
Show child attributes
The update time of the lead
The groups that the lead in. Deprecated, use segments instead.
["VIP Clients", "Open House Feb"]The segments that the lead in
["First-Time Buyers", "Downtown Area"]Unsubscription the email
Types of lead, expressed by ID. Type ID : Other (-1), Seller (1), Buyer (2), Renter (5), Investor (6), Agent (7), Homeowner (8), Landlord (9)
[2, 5]The last touch time of the lead
The last visit time of the lead
The status of the phone number Type id: invaild number(1), vaild number(2), talked(3), DNC Number(4), DNC Contact(5)
[2, 3]Whether complete all lead assign process
buying time frame, 1-3, 3-6, 6-12, 12+, Just Looking, Refinancing.
"6-12"
Pre-qual, Yes or No
"Yes"
House to Sell, Yes or No
"Yes"
first time home buyer, Yes or No
"Yes"
With buyer Agent, Yes or No
"Yes"
selling time frame, 1-3, 3-6, 6-12, 12+, Just Looking, Refinancing.
"1-3"
Mortgage, Yes or No.
"Yes"
Buy a house, Yes or No.
"Yes"
With listing agent, Yes or No.
"Yes"
The opportunity type of the lead
"High Interest"
A list of family members associated with the lead
Show child attributes
Show child attributes
The Id of the lead's pond
The Name of the lead's pond
Show child attributes
Show child attributes
The language of the lead
curl --request GET \
--url https://api.lofty.com/v1.0/leads/{leadId} \
--header 'Authorization: <authorization>'{
"cannotText": true,
"cannotCall": true,
"cannotEmail": true,
"leadId": 123,
"leadUserId": 123,
"firstName": "<string>",
"lastName": "<string>",
"birthday": "<string>",
"emails": [
"jane.doe@example.com",
"jdoe-work@company.com"
],
"phones": [
"+14155551234",
"+12125559876"
],
"leadSource": 123,
"source": "<string>",
"stageId": 123,
"stage": "<string>",
"assignedUserId": 123,
"assignedUser": "<string>",
"lenderUserId": 123,
"score": 123,
"tags": [
{
"leadId": 123,
"tagId": 123,
"createTime": "<string>",
"updateTime": "<string>",
"tagName": "<string>",
"creatorUserId": 123,
"visibleType": 123
}
],
"teamId": 123,
"streetAddress": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"createTime": "<string>",
"assignTime": "<string>",
"facebook": "<string>",
"twitter": "<string>",
"hiddenFlag": true,
"referredBy": "<string>",
"leadInquiry": {
"priceMin": 1,
"priceMax": 10000000,
"propertyType": [
"Single Family Home",
"Condo"
],
"bedroomsMin": 1,
"bathroomsMin": "1",
"locations": [
{
"city": "Austin",
"stateCode": "TX"
}
],
"id": 123,
"leadUserId": 123,
"bedroomsMax": 123,
"bathroomsMax": "<string>",
"modifyByAgent": true,
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z",
"defaultValue": true
},
"leadPropertyList": [
{
"price": 100000,
"state": "California",
"city": "New York",
"streetAddress": "22348 Regnart RD",
"zipCode": "25401",
"county": "<string>",
"propertyType": "Single Family Home",
"bedrooms": 3,
"bathrooms": 2,
"squareFeet": 100,
"lotSize": 26.33,
"parkingSpace": 1,
"floors": 1,
"mailAddress": true,
"id": 123,
"leadUserId": 123,
"listingId": "<string>",
"autoListingId": 123,
"label": "<string>",
"note": "<string>",
"listingStatus": "<string>",
"labelList": "<string>",
"pictureUrl": "<string>",
"siteListingUrl": "<string>",
"labelType": "<string>"
}
],
"customAttributes": [
{
"attributeName": "<string>",
"attributeType": "number, text, date, single_select, multi_select, percentage, currency",
"value": "<string>",
"params": "<string>"
}
],
"lastUpdateTime": "<string>",
"groups": [
"VIP Clients",
"Open House Feb"
],
"segments": [
"First-Time Buyers",
"Downtown Area"
],
"unsubscription": true,
"leadTypes": [
2,
5
],
"lastTouch": "<string>",
"lastVisit": "<string>",
"phoneStatuses": [
2,
3
],
"assignCompletionStatus": true,
"buyingTimeFrame": "6-12",
"preQual": "Yes",
"houseToSell": "Yes",
"fthb": "Yes",
"withBuyerAgent": "Yes",
"sellingTimeFrame": "1-3",
"mortgage": "Yes",
"buyHouse": "Yes",
"withListingAgent": "Yes",
"opportunity": "High Interest",
"leadFamilyMemberList": [
{
"firstName": "<string>",
"relationship": "<string>",
"lastName": "<string>",
"phones": [
"+14155551234"
],
"emails": [
"spouse@example.com"
],
"birthday": "<string>"
}
],
"pondId": 123,
"pondName": "<string>",
"customRoleList": [
{
"roleId": 123,
"role": "<string>",
"assigneeId": 123,
"assignee": "<string>"
}
],
"language": "<string>",
"ownershipId": 123,
"ownershipScope": "<string>"
}