Load CRM-ready property intelligence for a contact

Feature-flagged endpoint that combines RentCast property records, value and rent AVMs, active sale/rental listings, market statistics, and Google Street View metadata for a single contact or address. The response intentionally omits property-owner names and mailing addresses.

GET

https://api.channelautomation.com/api/property-intelligence/demo-brief

Authorization

BearerAuth
optional
HTTP Bearer (JWT)

ApiKeyAuth
optional
API key in header

Query parameters

workspace_id
optional
string
Workspace ID, accepted as a query fallback when the header is unavailable.
contact_id
optional
string
Contact ID to look up a stored workspace-scoped address when address is omitted.
address
optional
string
Full property address. Used only when contact_id is omitted or unavailable.
listingLimit
optional
integer
Number of active sale and rental listings to include.

maximum: 10 · minimum: 1 · default: 3

Header parameters

X-Workspace-Id
string
required
Workspace ID for data isolation

Returns

200

CRM-ready property intelligence brief.

400

Missing workspace ID, address, or contact address.

401

Authentication required

JSON

error
optional
string
success
optional
boolean

404

Feature disabled, contact not found, or route hidden.

500

Internal server error

JSON

error
optional
string
details
optional
string
success
optional
boolean

Load CRM-ready property intelligence for a contact

curl --request GET \
  --url https://api.channelautomation.com/api/property-intelligence/demo-brief \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Workspace-Id: 15213'

const url = 'https://api.channelautomation.com/api/property-intelligence/demo-brief';
const options = {
  method: 'GET',
  headers: {'X-Workspace-Id': '15213', Authorization: 'Bearer <token>'}
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/property-intelligence/demo-brief"

headers = {
    "X-Workspace-Id": "15213",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

Response example

{
  "error": "Authentication required",
  "success": false
}

{
  "error": "Internal server error",
  "details": "string",
  "success": false
}