Skip to main content
GET
/
v1.0
/
leads
/
{leadId}
/
transaction
/
{transactionId}
Get Transaction
curl --request GET \
  --url https://api.lofty.com/v1.0/leads/{leadId}/transaction/{transactionId} \
  --header 'Authorization: <authorization>'
{
  "transactionName": "123 Main St",
  "created": 1518078026000,
  "updated": 1518078026000,
  "transactionId": 10001,
  "leadName": "Bob",
  "assignedAgent": 100001,
  "transactionType": "Purchase",
  "homePrice": 1000000,
  "transactionStatus": "Pre-contract",
  "expectedCloseDate": 1508580010000,
  "closeDate": 1508580010000,
  "commissionRate": 3,
  "gci": 5000,
  "teamRevenue": 1000,
  "agentRevenue": 4000,
  "appointmentDate": 1508580010000,
  "agreementSignedDate": 1508580010000,
  "offerDate": 1508580010000,
  "contractDate": 1508580010000,
  "appraisalDate": 1508580010000,
  "homeInspectionDate": 1508580010000,
  "escrowDate": 1508580010000,
  "expiration": 1508580010000,
  "customFields": [
    {
      "id": 123,
      "value": "<string>"
    }
  ],
  "commissions": {
    "preSplit": [
      {
        "id": 123,
        "splitPayType": "TEAM",
        "splitPayTo": 123,
        "splitPayToName": "<string>",
        "payType": "TEAM",
        "payTo": 123,
        "payToName": "<string>",
        "value": 123,
        "calculateType": "PERCENT",
        "desc": "<string>"
      }
    ],
    "split": [
      {
        "id": 123,
        "splitPayType": "TEAM",
        "splitPayTo": 123,
        "splitPayToName": "<string>",
        "payType": "TEAM",
        "payTo": 123,
        "payToName": "<string>",
        "value": 123,
        "calculateType": "PERCENT",
        "desc": "<string>"
      }
    ],
    "postSplit": [
      {
        "id": 123,
        "splitPayType": "TEAM",
        "splitPayTo": 123,
        "splitPayToName": "<string>",
        "payType": "TEAM",
        "payTo": 123,
        "payToName": "<string>",
        "value": 123,
        "calculateType": "PERCENT",
        "desc": "<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

​
Authorization
string
required

Bearer [access_token]

Path Parameters

​
leadId
integer<int64>
required

Lead ID. Must be manageable by the caller.

​
transactionId
integer<int64>
required

Transaction ID. Must exist and be bound to leadId.

Response

The requested transaction.

​
transactionName
string
required

Property address or deal name. Required on create. Must not be blank and must not contain '<' or '>' characters.

Example:

"123 Main St"

​
created
integer<int64>
read-only

Transaction creation timestamp, in milliseconds since Unix epoch (UTC). Do not supply on create.

Example:

1518078026000

​
updated
integer<int64>
read-only

Transaction last-modified timestamp, in milliseconds since Unix epoch (UTC). Do not supply on create or update.

Example:

1518078026000

​
transactionId
integer<int64>
read-only

Transaction ID. Do not supply on create.

Example:

10001

​
leadName
string

Name of the lead this transaction belongs to. Ignored if supplied in a request body.

Example:

"Bob"

​
assignedAgent
integer<int64>

User ID of the agent this transaction is assigned to. Ignored if supplied in a request body.

Example:

100001

​
transactionType
enum<string>

Transaction type. Case-sensitive; must be one of the supported values. Values not matching the team's configured pipeline types fall back silently to the first pipeline (typically 'Purchase / Pre-contract'); always pass a valid type to avoid this silent behavior.

Available options:
Purchase,
Listing,
Lease,
Other
Example:

"Purchase"

​
homePrice
number

Home price of the transaction.

Example:

1000000

​
transactionStatus
string

Transaction status name. Must match one of the statuses configured in the team's pipeline for the given transactionType; unmatched values silently fall back to the first status of that type.

Example:

"Pre-contract"

​
expectedCloseDate
integer<int64>

Expected close date, in milliseconds since Unix epoch (UTC).

Example:

1508580010000

​
closeDate
integer<int64>

Actual close date, in milliseconds since Unix epoch (UTC).

Example:

1508580010000

​
commissionRate
number

Commission rate, expressed as a percentage (e.g. 3 for 3%).

Example:

3

​
gci
number

Gross Commission Income (GCI) of the transaction.

Example:

5000

​
teamRevenue
number

Portion of the GCI attributed to the team.

Example:

1000

​
agentRevenue
number

Portion of the GCI attributed to the agent.

Example:

4000

​
appointmentDate
integer<int64>

Appointment date, in milliseconds since Unix epoch (UTC).

Example:

1508580010000

​
agreementSignedDate
integer<int64>

Agreement-signed date, in milliseconds since Unix epoch (UTC).

Example:

1508580010000

​
offerDate
integer<int64>

Offer date, in milliseconds since Unix epoch (UTC).

Example:

1508580010000

​
contractDate
integer<int64>

Contract date, in milliseconds since Unix epoch (UTC).

Example:

1508580010000

​
appraisalDate
integer<int64>

Appraisal date, in milliseconds since Unix epoch (UTC).

Example:

1508580010000

​
homeInspectionDate
integer<int64>

Home-inspection date, in milliseconds since Unix epoch (UTC).

Example:

1508580010000

​
escrowDate
integer<int64>

Escrow date, in milliseconds since Unix epoch (UTC).

Example:

1508580010000

​
expiration
integer<int64>

Expiration date (listing / contract), in milliseconds since Unix epoch (UTC).

Example:

1508580010000

​
customFields
object[]

Custom field values; full-coverage update or insertion. See GET /v1.0/transaction/customfields for the team's custom field definitions.

​
commissions
object

Commission structure (preSplit / split / postSplit). See POST /v1.0/leads/{leadId}/transaction description for validation rules.