Browse the documentation

Opportunities (Radar)

The opportunities Radar finds between properties and clients — in the account itself and with partners — under the same display rules as the dashboard.

Routes

GET/v1/properties/{propertyId}/matches

A property's opportunities

The clients that fit the property. Only the account's own clients — partner clients never show up on your property.

Permission: radar:read

Path parameters

propertyIdstringrequired
Property id (prop-…).

Response200OK

datalist of Matchrequired
The opportunities.
nextCursorstringrequirednullable
Next page cursor (null = done).

Example

curl -X GET 'https://api.imobyflow.com.br/v1/properties/prop-3f9a1c2b7d4e/matches' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en'

Errors for this route

And the errors common to every route

GET/v1/leads/{leadId}/matches

A client's opportunities

The properties that fit the client — own and from partners.

Permission: radar:read

Path parameters

leadIdstringrequired
Client id (lead-…).

Response200OK

datalist of Matchrequired
The opportunities.
nextCursorstringrequirednullable
Next page cursor (null = done).

Example

curl -X GET 'https://api.imobyflow.com.br/v1/leads/lead-7c2e9a1b3d5f/matches' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en'

Errors for this route

And the errors common to every route

GET/v1/leads/{leadId}/radar

Why a client gets no recommendations

The diagnosis the dashboard shows on the client: what is missing in the profile (pending) and what is missing in the market (misses — how many properties the Radar evaluated and left out, why, and what to do). The reasons are recounted on every change to the client; a matching property added later becomes a recommendation right away, without waiting for that.

Permission: radar:read

Path parameters

leadIdstringrequired
Client id (lead-…).

Response200OK

dataLeadRadarDiagnosisrequired
The diagnosis.

Example

curl -X GET 'https://api.imobyflow.com.br/v1/leads/lead-7c2e9a1b3d5f/radar' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en'

Errors for this route

And the errors common to every route

GET/v1/matches

The account's opportunities

The opportunities. NEW ones (the default) are the dashboard inbox: by priority, up to the broker's open-opportunity limit — the rest come in as the inbox empties; paginate with the cursor. Other statuses come most recently changed first, and archived ones include those that lost relevance (lostRelevance: true). Partner ones follow the dashboard display rule: without an active subscription the partner stays hidden (locked); the partner property's website and commission stay in the dashboard. The client's name only comes with leads:read on the key.

Permission: radar:read

Query parameters

limitinteger
Items per page: 1 to 100 (default 50).
cursorstring
The nextCursor from the previous page. The list is over when it comes back null. It is only valid for this route and this account.
statusstring
Status.one of NEW FAVORITED ARCHIVED REQUESTED
scopestring
Origin.one of INTERNAL NETWORK LAUNCH
ownerAccountIdstring
Only one broker's items.

Response200OK

datalist of Matchrequired
The opportunities.
nextCursorstringrequirednullable
Next page cursor (null = done).

Example

curl -X GET 'https://api.imobyflow.com.br/v1/matches' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en'

Errors for this route

And the errors common to every route

POST/v1/matches/{matchId}/dismiss

Dismiss an opportunity

The broker's decision, made in your system. A favorited opportunity cannot be dismissed.

Permission: radar:writeSupports dry runSupports Idempotency-Key

Path parameters

matchIdstringrequired
Opportunity id. It contains #: send it URL-encoded (%23).

Query parameters

dryRunboolean
true = dry run: validates and says what would happen, without writing anything.

Response200OK

dataMatchrequired
The object as it now stands.
resultMatchWriteResultrequired
The outcome.

Example

# Dry run: nothing is written. Remove ?dryRun=true to write for real.
curl -X POST 'https://api.imobyflow.com.br/v1/matches/m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L/dismiss?dryRun=true' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en' \
  -H "Idempotency-Key: $(uuidgen)"

Errors for this route

And the errors common to every route

POST/v1/matches/{matchId}/restore

Restore an opportunity

Brings a dismissed opportunity back to new.

Permission: radar:writeSupports dry runSupports Idempotency-Key

Path parameters

matchIdstringrequired
Opportunity id. It contains #: send it URL-encoded (%23).

Query parameters

dryRunboolean
true = dry run: validates and says what would happen, without writing anything.

Response200OK

dataMatchrequired
The object as it now stands.
resultMatchWriteResultrequired
The outcome.

Example

# Dry run: nothing is written. Remove ?dryRun=true to write for real.
curl -X POST 'https://api.imobyflow.com.br/v1/matches/m%23prop-3f9a1c2b7d4e%23lead-7c2e9a1b3d5f%23L/restore?dryRun=true' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en' \
  -H "Idempotency-Key: $(uuidgen)"

Errors for this route

And the errors common to every route

Objects

RadarMiss

One reason why evaluated properties did not become recommendations.

codestringrequired
The reason, as a stable code. A new reason without a code comes as OTHER, with its count.one of OUT_OF_BUDGET OTHER_NEIGHBORHOOD OTHER_CITY OTHER_TYPE OTHER_PURPOSE LOW_SCORE AWAITING_REVIEW NOT_SHARED DEVELOPER_INACTIVE DEVELOPMENT_OFF_MARKET PROPERTY_INCOMPLETE LEAD_INCOMPLETE OTHER
countintegerrequired
How many properties stopped at this reason.
labelstringrequired
The reason, spelled out.
actionstringrequirednullable
What to do about it (null for OTHER).

LeadRadarDiagnosis

Why the client receives recommendations, or not.

leadIdstringrequired
Client id.
statestringrequired
ACTIVE, ARCHIVED or DELETED.one of ACTIVE ARCHIVED DELETED
blockedBystringrequirednullable
Why the client is out of the Radar before any pending item: archived, in the trash, or closed in the funnel (Won or Lost). Null: nothing blocks it. Out of the Radar, the market diagnosis is not returned.one of ARCHIVED DELETED FUNNEL_CLOSED
blockedLabelstringrequirednullable
The reason, spelled out.
eligiblebooleanrequired
Receives recommendations: nothing blocks it (blockedBy null) and nothing is missing in the profile.
pendinglist of stringrequired
What is missing in the PROFILE — the same codes as the client's radar.one of PURPOSE_MISSING PROPERTY_TYPES_MISSING CITY_MISSING CITY_NOT_IN_CATALOG BUDGET_MISSING SALE_BUDGET_MISSING RENT_BUDGET_MISSING OTHER
labelslist of stringrequired
The same pending items, spelled out.
tierstringrequirednullable
The search profile tier: the more specific, the more recommendations the Radar keeps for the client. Null: the Radar has not evaluated the client yet, or the client is out of the Radar (blockedBy).one of PRECISE GOOD BROAD INCOMPLETE
tierLabelstringrequirednullable
The tier, spelled out.
reachintegerrequirednullable
How many new recommendations the Radar keeps for this client.
opportunitiesintegerrequirednullable
How many new recommendations the client has now.
misseslist of RadarMissrequired
What is missing in the MARKET: why the evaluated properties were left out, from the most to the least frequent reason (up to 5). Empty when nothing was left out, when the profile is incomplete (see pending) or when the client is out of the Radar (blockedBy).

PropertySnapshot

The property snapshot in the pair — the same as the card. Fields the dashboard hides come back null.

titlestringrequirednullable
Title.
typestringrequirednullable
Subtype.
purposestringrequirednullable
Purpose of the pair.
purposeslist of stringrequired
The property's purposes.
pricenumberrequirednullable
Price (sale, or rent when the pair is a rental).
priceFrombooleanrequired
The price is a "starting at" price (new development).
rentPricenumberrequirednullable
Rent.
citystringrequirednullable
City.
neighborhoodstringrequirednullable
Neighborhood.
bedroomsintegerrequirednullable
Bedrooms.
bathroomsintegerrequirednullable
Bathrooms.
parkingSpotsintegerrequirednullable
Parking spots.
areanumberrequirednullable
Area, in m².
coverPhotostringrequirednullable
Cover photo.
listingUrlstringrequirednullable
Listing URL (null when the dashboard hides it too, and always null for a partner property, NETWORK).
commissionPercentnumberrequirednullable
Sale commission, in % (null for a partner property — it stays in the dashboard).
rentCommissionMonthsnumberrequirednullable
Rent commission, in months (null for a partner property).
splitListingPercentnumberrequirednullable
Listing side share, in % (null for a partner property).
lastConfirmedAtstringrequirednullable
Last availability confirmation.
deliveryDatestringrequirednullable
Delivery (new development).
developmentIdstringrequirednullable
Development.
developmentNamestringrequirednullable
Development name.

ClientSnapshot

The client snapshot in the pair.

maskedbooleanrequired
The client belongs to a partner and is masked.
statusstringrequirednullable
Funnel stage.
preApprovedbooleanrequired
Pre-approved credit.
purposeslist of stringrequired
Purposes wanted.
propertyTypeslist of stringrequired
Types wanted.
regionslist of stringrequired
Regions, spelled out.
priceMinnumberrequirednullable
Minimum.
priceMaxnumberrequirednullable
Maximum.
bedroomsintegerrequirednullable
Bedrooms.
parkingSpotsintegerrequirednullable
Parking spots.
areaMinnumberrequirednullable
Minimum area.
namestringrequirednullable
Name — only with the leads:read permission on the key and only when the dashboard shows it too. Phone, never.

Counterpart

The partner on the other side.

accountIdstringrequired
Partner's account id.
namestringrequirednullable
Name.
typestringrequirednullable
Account type.
organizationstringrequirednullable
Partner's agency.
crecistringrequirednullable
Broker license (CRECI).
creciVerifiedbooleanrequired
License verified.
phonestringrequirednullable
Phone.

Match

An opportunity: a property that fits a client.

idstringrequired
Opportunity id (m#{property}#{client}#{side}). It contains #: URL-encode it (%23) in the path.
scopestringrequired
INTERNAL (own portfolio), NETWORK (with partners) or LAUNCH (new development).one of INTERNAL NETWORK LAUNCH
statusstringrequired
NEW, FAVORITED, ARCHIVED or REQUESTED (became a partnership request).
scoreintegerrequired
Score from 0 to 100.
reasonslist of stringrequired
Why it matches.
gapslist of stringrequired
What doesn't match.
propertyIdstringrequirednullable
Property.
leadIdstringrequirednullable
Client.
ownerAccountIdstringrequirednullable
The in-house broker who gets the opportunity.
ownerNamestringrequirednullable
Their name.
lockedbooleanrequired
Partner opportunity without an active subscription — the partner stays hidden, as in the dashboard.
lostRelevancebooleanrequired
No longer matches after a change.
propertyPropertySnapshotrequirednullable
The property.
clientClientSnapshotrequirednullable
The client.
counterpartCounterpartrequirednullable
The partner (null when in-house or hidden).
favoriteMatchFavoriterequirednullable
The client's answer to the favorite — only in FAVORITED and with leads:read on the key.
createdAtstringrequired
When it was created (UTC).
updatedAtstringrequired
Last change (UTC).

MatchFavorite

What the client answered about this property, through the favorites link.

addedAtstringrequired
When it was added to the client's favorites (UTC).
reactionstringrequirednullable
LIKE or DISLIKE. Null: no answer yet.one of LIKE DISLIKE
reactionAtstringrequirednullable
When the client answered (UTC).
commentstringrequirednullable
The note the client wrote.
commentAtstringrequirednullable
When the client wrote it (UTC).

MatchWriteResult

The outcome.

outcomestringrequired
APPLIED; in a dry run, WOULD_APPLY.
dryRunbooleanrequired
It was a dry run.