v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB

Lead Transaction

Get Property Address

Returns the property address associated with a transaction.

get/v1.0/leads/{leadId}/transaction/{transactionId}/property/address

Path parameters

leadIdinteger required

Lead ID. Must be manageable by the caller.

transactionIdinteger required

Transaction ID. Must exist and be bound to leadId.

Headers

Authorizationstring required

Bearer [access_token]

Response

Property address.

transactionIdinteger required

Transaction ID whose property address is being queried or updated. Required on the update endpoint (carried in the request body, not the URL).

unitstring

Unit / apartment number.

labelstring

Free-form label for the address (e.g. 'Investment', 'Primary Residence').

statestring

State or province code.

citystring

City.

zipCodestring

Postal / ZIP code.

streetAddressstring

Street address.

countystring

County.

Example response

{
  "transactionId": 10001,
  "unit": "1",
  "label": "Investment",
  "state": "CA",
  "city": "Los Angeles",
  "zipCode": "90012",
  "streetAddress": "100 W 1st St",
  "county": "Los Angeles"
}