Clients
The account's clients, with the search profile that drives recommendations: read, sync by your system's code, move through the funnel, archive and log interactions.
- GET/v1/leads— List clients
- GET/v1/leads/{leadId}— One client
- GET/v1/leads/by-ref/{ref}— One client by your code
- GET/v1/leads/{leadId}/favorites— A client's favorites and answers
- PUT/v1/leads/by-ref/{ref}— Create, update or link by your code
- POST/v1/leads— Create a client
- PATCH/v1/leads/{leadId}— Partially update a client
- POST/v1/leads/{leadId}/state— Archive or reactivate
- POST/v1/leads/{leadId}/interactions— Log an interaction
- DELETE/v1/leads/{leadId}— Move to the trash
Routes
/v1/leadsList clients
The account's clients, newest first, with filters.
leads:readQuery parameters
limitinteger- Items per page: 1 to 100 (default 50).
cursorstring- The
nextCursorfrom the previous page. The list is over when it comes back null. It is only valid for this route and this account. statestringACTIVE(default),ARCHIVEDorDELETED.one ofACTIVEARCHIVEDDELETEDstatusstring- Stage.one of
NEWATTENDINGPROPOSALWONLOST ownerAccountIdstring- Only one broker's items.
updatedSincestring- Only what changed since this date/time (ISO 8601; with an offset, converted to UTC; without one, taken as UTC).
radarstringpending= only items with recommendation pending items;ready= only ready items.one ofpendingready
Response200OK
datalist of Leadrequired- The clients.
nextCursorstringrequirednullable- Next page cursor (null = done).
Example
curl -X GET 'https://api.imobyflow.com.br/v1/leads' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: en'Errors for this route
/v1/leads/{leadId}One client
The client, with the search profile and recommendation status.
leads:readPath parameters
leadIdstringrequired- Client id (
lead-…).
Response200OK
dataLeadrequired- The client.
Example
curl -X GET 'https://api.imobyflow.com.br/v1/leads/lead-7c2e9a1b3d5f' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: en'Errors for this route
/v1/leads/by-ref/{ref}One client by your code
The client by your system's code — also when it is in the trash (state: DELETED).
leads:readPath parameters
refstringrequired- The client's code in your system (up to 80 characters).
Response200OK
dataLeadrequired- The client.
Example
curl -X GET 'https://api.imobyflow.com.br/v1/leads/by-ref/CLI-889' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: en'Errors for this route
/v1/leads/{leadId}/favoritesA client's favorites and answers
The properties the broker picked for the client and what the client answered through the link: ❤️ (LIKE), ❌ (DISLIKE) and the note. The property comes as the client sees it — without owner, partner, original listing, commission or exact address. To find who answered without opening each client, use GET /v1/matches?status=FAVORITED: each opportunity carries favorite (properties favorited outside the Radar only show up here).
leads:readPath parameters
leadIdstringrequired- Client id (
lead-…).
Response200OK
dataFavoritesBoardrequired- The favorites.
Example
curl -X GET 'https://api.imobyflow.com.br/v1/leads/lead-7c2e9a1b3d5f/favorites' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: en'Errors for this route
/v1/leads/by-ref/{ref}Create, update or link by your code
Creates the client (201), updates it (200) — or LINKS it: the code is new but the person is already here by phone or e-mail (from a portal, a spreadsheet); the code now points to them (LINKED), without a second client. On creation, consentGiven: true is required. The code's client in the trash → 409 lead_in_trash, before any other check: restore it in the dashboard.
leads:writeSupports dry runSupports Idempotency-KeyPath parameters
refstringrequired- The client's code in your system (up to 80 characters).
Query parameters
dryRunbooleantrue= dry run: validates and says what would happen, without writing anything.
Request body
externalRefstring- The client's code in your system (POST only).
namestring- Name. Required on creation.
phoneslist of PhoneInput- Up to 5 phones. On creation, a phone or an e-mail.
emailstringnullable- E-mail.
statusstring- Funnel stage.one of
NEWATTENDINGPROPOSALWONLOST notesstring- Notes.
preApprovedboolean- Pre-approved credit.
sharedToNetworkboolean- The profile may receive partner properties.
interestInterestInput- Search profile.
ownerAccountIdstring- The responsible broker, by id.
ownerEmailstring- The responsible broker, by e-mail — the way your system knows them. Without one, the agency's distribution rule applies.
lastActivityAtstring- The last activity in YOUR system. It only moves forward. More than 60 days ago on creation = the client is created archived (historical base).
consentGivenboolean- Must be
trueon creation: the agency declares it has the legal basis to process the data (API Terms).
Example body
{
"name": "Carlos Pereira",
"phones": [
{
"number": "(41) 99999-8888",
"isWhatsApp": true
}
],
"email": "carlos@example.com",
"status": "ATTENDING",
"ownerEmail": "marina@suaimobiliaria.com.br",
"interest": {
"purposes": [
"VENDA"
],
"propertyTypes": [
"APARTAMENTO"
],
"locations": [
{
"cityId": "4106902",
"neighborhoodSlug": "bigorrilho"
}
],
"salePriceMax": 950000,
"bedrooms": 3
},
"lastActivityAt": "2026-10-02T15:00:00Z",
"consentGiven": true
}Response200OK201 when it creates.
dataLeadrequired- The object as it now stands.
resultLeadWriteResultrequired- The outcome.
Example
# Dry run: nothing is written. Remove ?dryRun=true to write for real.
curl -X PUT 'https://api.imobyflow.com.br/v1/leads/by-ref/CLI-889?dryRun=true' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: en' \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
--data @- <<'JSON'
{
"name": "Carlos Pereira",
"phones": [
{
"number": "(41) 99999-8888",
"isWhatsApp": true
}
],
"email": "carlos@example.com",
"status": "ATTENDING",
"ownerEmail": "marina@suaimobiliaria.com.br",
"interest": {
"purposes": [
"VENDA"
],
"propertyTypes": [
"APARTAMENTO"
],
"locations": [
{
"cityId": "4106902",
"neighborhoodSlug": "bigorrilho"
}
],
"salePriceMax": 950000,
"bedrooms": 3
},
"lastActivityAt": "2026-10-02T15:00:00Z",
"consentGiven": true
}
JSONErrors for this route
/v1/leadsCreate a client
Creates a client. Minimum: name, a phone or e-mail and consentGiven: true. An existing contact → 409 with the id. Without an owner, the agency's distribution rule applies.
leads:writeSupports dry runSupports Idempotency-KeyQuery parameters
dryRunbooleantrue= dry run: validates and says what would happen, without writing anything.
Request body
externalRefstring- The client's code in your system (POST only).
namestring- Name. Required on creation.
phoneslist of PhoneInput- Up to 5 phones. On creation, a phone or an e-mail.
emailstringnullable- E-mail.
statusstring- Funnel stage.one of
NEWATTENDINGPROPOSALWONLOST notesstring- Notes.
preApprovedboolean- Pre-approved credit.
sharedToNetworkboolean- The profile may receive partner properties.
interestInterestInput- Search profile.
ownerAccountIdstring- The responsible broker, by id.
ownerEmailstring- The responsible broker, by e-mail — the way your system knows them. Without one, the agency's distribution rule applies.
lastActivityAtstring- The last activity in YOUR system. It only moves forward. More than 60 days ago on creation = the client is created archived (historical base).
consentGivenboolean- Must be
trueon creation: the agency declares it has the legal basis to process the data (API Terms).
Example body
{
"externalRef": "CLI-889",
"name": "Carlos Pereira",
"phones": [
{
"number": "(41) 99999-8888",
"isWhatsApp": true
}
],
"email": "carlos@example.com",
"status": "ATTENDING",
"ownerEmail": "marina@suaimobiliaria.com.br",
"interest": {
"purposes": [
"VENDA"
],
"propertyTypes": [
"APARTAMENTO"
],
"locations": [
{
"cityId": "4106902",
"neighborhoodSlug": "bigorrilho"
}
],
"salePriceMax": 950000,
"bedrooms": 3
},
"lastActivityAt": "2026-10-02T15:00:00Z",
"consentGiven": true
}Response201Created
dataLeadrequired- The object as it now stands.
resultLeadWriteResultrequired- The outcome.
Example
# Dry run: nothing is written. Remove ?dryRun=true to write for real.
curl -X POST 'https://api.imobyflow.com.br/v1/leads?dryRun=true' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: en' \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
--data @- <<'JSON'
{
"externalRef": "CLI-889",
"name": "Carlos Pereira",
"phones": [
{
"number": "(41) 99999-8888",
"isWhatsApp": true
}
],
"email": "carlos@example.com",
"status": "ATTENDING",
"ownerEmail": "marina@suaimobiliaria.com.br",
"interest": {
"purposes": [
"VENDA"
],
"propertyTypes": [
"APARTAMENTO"
],
"locations": [
{
"cityId": "4106902",
"neighborhoodSlug": "bigorrilho"
}
],
"salePriceMax": 950000,
"bedrooms": 3
},
"lastActivityAt": "2026-10-02T15:00:00Z",
"consentGiven": true
}
JSONErrors for this route
/v1/leads/{leadId}Partially update a client
Changes only what is sent. Changing the stage is logged but does not count as activity — for that send lastActivityAt or log an interaction.
leads:writeSupports dry runSupports Idempotency-KeyPath parameters
leadIdstringrequired- Client id (
lead-…).
Query parameters
dryRunbooleantrue= dry run: validates and says what would happen, without writing anything.
Request body
externalRefstring- The client's code in your system (POST only).
namestring- Name. Required on creation.
phoneslist of PhoneInput- Up to 5 phones. On creation, a phone or an e-mail.
emailstringnullable- E-mail.
statusstring- Funnel stage.one of
NEWATTENDINGPROPOSALWONLOST notesstring- Notes.
preApprovedboolean- Pre-approved credit.
sharedToNetworkboolean- The profile may receive partner properties.
interestInterestInput- Search profile.
ownerAccountIdstring- The responsible broker, by id.
ownerEmailstring- The responsible broker, by e-mail — the way your system knows them. Without one, the agency's distribution rule applies.
lastActivityAtstring- The last activity in YOUR system. It only moves forward. More than 60 days ago on creation = the client is created archived (historical base).
consentGivenboolean- Must be
trueon creation: the agency declares it has the legal basis to process the data (API Terms).
Example body
{
"status": "PROPOSAL",
"lastActivityAt": "2026-10-02T15:00:00Z"
}Response200OK
dataLeadrequired- The object as it now stands.
resultLeadWriteResultrequired- The outcome.
Example
# Dry run: nothing is written. Remove ?dryRun=true to write for real.
curl -X PATCH 'https://api.imobyflow.com.br/v1/leads/lead-7c2e9a1b3d5f?dryRun=true' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: en' \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
--data @- <<'JSON'
{
"status": "PROPOSAL",
"lastActivityAt": "2026-10-02T15:00:00Z"
}
JSONErrors for this route
/v1/leads/{leadId}/stateArchive or reactivate
ARCHIVED archives; ACTIVE reactivates. The same function as the dashboard.
leads:writeSupports dry runSupports Idempotency-KeyPath parameters
leadIdstringrequired- Client id (
lead-…).
Query parameters
dryRunbooleantrue= dry run: validates and says what would happen, without writing anything.
Request body
statestringrequired- The state.one of
ACTIVEARCHIVED
Example body
{
"state": "ARCHIVED"
}Response200OK
dataLeadrequired- The object as it now stands.
resultLeadWriteResultrequired- The outcome.
Example
# Dry run: nothing is written. Remove ?dryRun=true to write for real.
curl -X POST 'https://api.imobyflow.com.br/v1/leads/lead-7c2e9a1b3d5f/state?dryRun=true' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: en' \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
--data @- <<'JSON'
{
"state": "ARCHIVED"
}
JSONErrors for this route
/v1/leads/{leadId}/interactionsLog an interaction
A contact, visit, proposal or note made in YOUR system, with its date. It counts as activity (the client is not archived for inactivity).
leads:writeSupports dry runSupports Idempotency-KeyPath parameters
leadIdstringrequired- Client id (
lead-…).
Query parameters
dryRunbooleantrue= dry run: validates and says what would happen, without writing anything.
Request body
typestringrequiredCONTACT,VISIT,PROPOSALorNOTE.one ofCONTACTVISITPROPOSALNOTEnotestring- Note.
atstring- When it happened (default: now).
Example body
{
"type": "VISIT",
"note": "Visitou o AP1234 com a esposa.",
"at": "2026-10-02T15:00:00Z"
}Response200OK
dataLeadrequired- The object as it now stands.
resultLeadWriteResultrequired- The outcome.
Example
# Dry run: nothing is written. Remove ?dryRun=true to write for real.
curl -X POST 'https://api.imobyflow.com.br/v1/leads/lead-7c2e9a1b3d5f/interactions?dryRun=true' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: en' \
-H "Idempotency-Key: $(uuidgen)" \
-H 'Content-Type: application/json' \
--data @- <<'JSON'
{
"type": "VISIT",
"note": "Visitou o AP1234 com a esposa.",
"at": "2026-10-02T15:00:00Z"
}
JSONErrors for this route
/v1/leads/{leadId}Move to the trash
A 30-day trash; cancels the client's open partnerships, as the dashboard does. The same shrink guard as properties.
leads:writeSupports dry runSupports Idempotency-KeyPath parameters
leadIdstringrequired- Client id (
lead-…).
Query parameters
dryRunbooleantrue= dry run: validates and says what would happen, without writing anything.
Response200OK
dataLeadrequired- The object as it now stands.
resultLeadWriteResultrequired- The outcome.
Example
# Dry run: nothing is written. Remove ?dryRun=true to write for real.
curl -X DELETE 'https://api.imobyflow.com.br/v1/leads/lead-7c2e9a1b3d5f?dryRun=true' \
-H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
-H 'Accept-Language: en' \
-H "Idempotency-Key: $(uuidgen)"Errors for this route
Objects
NextStep
The scheduled next step.
duestringrequired- The day (
2026-11-21) or the day and time (2026-11-21T14:30), São Paulo time. titlestringrequired- What to do.
LeadCrm
The CRM follow-up. Fields come back null when the account does not use the CRM.
temperaturestringrequirednullable- The client's temperature.one of
HOTWARMCOLD temperatureLockedbooleanrequired- The team locked the temperature by hand — contact answers do not change it.
nextStepNextSteprequirednullable- The next step.
lastContactOutcomestringrequirednullable- How the last logged contact went.one of
THINKINGFAMILYFINANCINGWANTS_VISITMORE_OPTIONSDISLIKEDNO_ANSWERGAVE_UP lastContactAtstringrequirednullable- When the last contact was logged (UTC).
lostReasonstringrequirednullable- Why it was lost — only at the
LOSTstage.one ofBOUGHT_ELSEWHEREGAVE_UP_BUYINGCREDIT_DENIEDNOT_FOUNDSTOPPED_ANSWERINGOTHER lostNotestringrequirednullable- The loss note — only at the
LOSTstage.
Phone
A phone number.
numberstringrequired- Digits only, with area code (10 to 13).
isWhatsAppbooleanrequired- Is WhatsApp.
labelstringrequirednullable- Free label (
mobile,work…).
Location
A region of interest.
cityIdstringrequirednullable- IBGE code.
citySlugstringrequirednullable- City identifier.
cityNamestringrequirednullable- City name.
ufstringrequirednullable- State.
neighborhoodSlugstringrequirednullable- Catalog neighborhood (null = the whole city).
neighborhoodNamestringrequirednullable- Neighborhood name.
preferencestringrequiredPREFERREDorACCEPTABLE— it weighs on the recommendation score.one ofPREFERREDACCEPTABLE
Interest
The search profile — it is what drives recommendations.
purposeslist of stringrequired- Purposes:
VENDA(sale),LOCACAO(rent) or both.one ofVENDALOCACAO propertyTypeslist of stringrequired- Property types wanted.one of
APARTAMENTOCASA_RUACASA_CONDOMINIOCASA_VILASTUDIOFLATCOBERTURASALA_COMERCIALLOJA_PONTOGALPAOPREDIOTERRENO_RUATERRENO_CONDOMINIOCHACARA_SITIOFAZENDA locationslist of Locationrequired- Regions of interest.
similarNeighborhoodsbooleanrequired- Accepts neighborhoods similar to the chosen ones.
salePriceMinnumberrequirednullable- Purchase: minimum, in BRL.
salePriceMaxnumberrequirednullable- Purchase: maximum, in BRL.
rentPriceMinnumberrequirednullable- Rent: minimum, in BRL.
rentPriceMaxnumberrequirednullable- Rent: maximum, in BRL.
bedroomsintegerrequirednullable- Minimum bedrooms.
bathroomsintegerrequirednullable- Minimum bathrooms.
parkingSpotsintegerrequirednullable- Minimum parking spots.
areaMinnumberrequirednullable- Minimum area, in m².
LeadRadar
The client's status in recommendations.
eligiblebooleanrequired- Receives recommendations right now: active, open in the funnel (New, In progress or Proposal) and with no pending item.
pendinglist of stringrequired- What is missing in the search profile.one of
PURPOSE_MISSINGPROPERTY_TYPES_MISSINGCITY_MISSINGCITY_NOT_IN_CATALOGBUDGET_MISSINGSALE_BUDGET_MISSINGRENT_BUDGET_MISSINGOTHER labelslist of stringrequired- The same pending items, spelled out.
Lead
A client of the account. Name, phone and e-mail are personal data — the agency is the controller.
idstringrequired- Client id.
externalRefstringrequirednullable- The client's code in YOUR system.
ownerAccountIdstringrequirednullable- The responsible broker (or the agency itself).
statestringrequiredACTIVE,ARCHIVEDorDELETED(trash).one ofACTIVEARCHIVEDDELETEDstatusstringrequirednullable- Funnel stage.one of
NEWATTENDINGPROPOSALWONLOST namestringrequirednullable- Name.
phoneslist of Phonerequired- Phones.
emailstringrequirednullable- E-mail.
sourcestringrequired- Where it came from:
MANUAL,IMPORT_CSV,EMAIL,WEBHOOK,META_ADS,PORTAL_API,CRM_API(through the API)… sourceDetailstringrequirednullable- Source detail (the portal, the system name).
sourcePropertyIdstringrequirednullable- The property that brought the client, if any.
preApprovedbooleanrequired- Pre-approved credit.
sharedToNetworkbooleanrequired- The profile (without name or contact) may receive partner properties.
notesstringrequirednullable- Notes.
interestInterestrequired- Search profile.
radarLeadRadarrequired- Recommendation status.
crmLeadCrmrequired- The CRM follow-up: temperature, next step and the loss reason.
lastActivityAtstringrequirednullable- Last activity — moves with the date your system sends and with interactions, never with sync itself.
archivedAtstringrequirednullable- When it was archived.
archivedReasonstringrequirednullable- Why it was archived (
MANUAL,INACTIVITY,IMPORT…). deletedAtstringrequirednullable- When it was moved to the trash.
createdAtstringrequired- When it was created (UTC).
updatedAtstringrequired- Last change (UTC).
PhoneInput
A phone. A plain string with the number is also accepted.
numberstring- With area code; only digits count.
isWhatsAppboolean- Is WhatsApp (default: yes).
labelstring- Free label.
LocationInput
A region of interest.
cityIdstring- IBGE code.
cityNamestring- City name (with
uf). ufstring- State.
neighborhoodSlugstring- Catalog neighborhood.
neighborhoodNamestring- Neighborhood as text. Market areas ("Ecoville") expand into the catalog neighborhoods they cover.
preferencestringPREFERRED(default) orACCEPTABLE.one ofPREFERREDACCEPTABLE
InterestInput
The search profile. Merged field by field: sending only the maximum does not erase the regions.
purposeslist of string- Purposes.one of
VENDALOCACAO propertyTypeslist of string- Types wanted.one of
APARTAMENTOCASA_RUACASA_CONDOMINIOCASA_VILASTUDIOFLATCOBERTURASALA_COMERCIALLOJA_PONTOGALPAOPREDIOTERRENO_RUATERRENO_CONDOMINIOCHACARA_SITIOFAZENDA locationslist of LocationInput- Regions (up to 20). Send the whole list when you send it.
similarNeighborhoodsboolean- Accepts similar neighborhoods.
salePriceMinnumbernullable- Purchase: minimum.
salePriceMaxnumbernullable- Purchase: maximum. Below the minimum is refused.
rentPriceMinnumbernullable- Rent: minimum.
rentPriceMaxnumbernullable- Rent: maximum. Below the minimum is refused.
bedroomsintegernullable- Minimum bedrooms.
bathroomsintegernullable- Minimum bathrooms.
parkingSpotsintegernullable- Minimum parking spots.
areaMinnumbernullable- Minimum area, in m².
LeadInput
The fields the API accepts for a client. Unknown fields are an error; absent fields are kept.
externalRefstring- The client's code in your system (POST only).
namestring- Name. Required on creation.
phoneslist of PhoneInput- Up to 5 phones. On creation, a phone or an e-mail.
emailstringnullable- E-mail.
statusstring- Funnel stage.one of
NEWATTENDINGPROPOSALWONLOST notesstring- Notes.
preApprovedboolean- Pre-approved credit.
sharedToNetworkboolean- The profile may receive partner properties.
interestInterestInput- Search profile.
ownerAccountIdstring- The responsible broker, by id.
ownerEmailstring- The responsible broker, by e-mail — the way your system knows them. Without one, the agency's distribution rule applies.
lastActivityAtstring- The last activity in YOUR system. It only moves forward. More than 60 days ago on creation = the client is created archived (historical base).
consentGivenboolean- Must be
trueon creation: the agency declares it has the legal basis to process the data (API Terms).
LeadWriteResult
The write outcome.
outcomestringrequired- What happened:
CREATED,UPDATED,UNCHANGED,LINKED(the code now points to a client that already existed by contact),ARCHIVED(created archived, historical base),STATE_SET(archived or reactivated),ADDED(interaction logged),DELETED,ALREADY_DELETED. dryRunbooleanrequired- It was a dry run — nothing was written.
interactionobject- The logged interaction (only in
POST /leads/{leadId}/interactions). interaction.idstringrequired- Record id.
interaction.typestringrequired- Type.
interaction.notestringrequirednullable- Note.
interaction.atstringrequirednullable- When it happened.
FavoriteProperty
The property as the client sees it through the link — without owner, partner, original listing, commission or exact address.
titlestringrequirednullable- Title.
typestringrequirednullable- Subtype.one of
APARTAMENTOCASA_RUACASA_CONDOMINIOCASA_VILASTUDIOFLATCOBERTURASALA_COMERCIALLOJA_PONTOGALPAOPREDIOTERRENO_RUATERRENO_CONDOMINIOCHACARA_SITIOFAZENDA purposeslist of stringrequired- Purposes:
VENDA(sale),LOCACAO(rent) or both.one ofVENDALOCACAO salePricenumberrequirednullable- Sale price, in BRL.
rentPricenumberrequirednullable- Rent, in BRL.
citystringrequirednullable- City.
neighborhoodstringrequirednullable- Neighborhood.
bedroomsintegerrequirednullable- Bedrooms.
bathroomsintegerrequirednullable- Bathrooms.
parkingSpotsintegerrequirednullable- Parking spots.
areanumberrequirednullable- Total private area, in m².
coverPhotostringrequirednullable- The cover photo.
FavoriteItem
One property in the client's favorites and the client's answer.
propertyIdstringrequired- Property id (it may belong to a partner: then
GET /v1/properties/{id}does not return it). matchIdstringrequirednullable- The opportunity the favorite came from, when there was one.
scoreintegerrequirednullable- The opportunity score, from 0 to 100.
addedAtstringrequired- When it was added (UTC).
availablebooleanrequired- Still on the market.
false: taken off the market — the data is from when it was added. reactionstringrequirednullableLIKEorDISLIKE. Null: no answer yet.one ofLIKEDISLIKEreactionAtstringrequirednullable- When the client answered (UTC).
commentstringrequirednullable- The note the client wrote.
commentAtstringrequirednullable- When the client wrote it (UTC).
propertyFavoritePropertyrequired- The property.
FavoritesBoard
The client's favorites: what the broker picked and what the client answered.
leadIdstringrequired- Client id.
shareUrlstringrequirednullable- The permanent link the client opens. Null: the client has no favorites yet.
titlestringrequirednullable- The title the broker gave the page.
notestringrequirednullable- The broker's note at the top of the page.
itemslist of FavoriteItemrequired- The properties, newest first.
likeCountintegerrequired- How many the client liked.
dislikeCountintegerrequired- How many the client disliked.
commentCountintegerrequired- How many have a note.
unavailableCountintegerrequired- How many were taken off the market.
viewCountintegerrequired- How many times the client opened the page.
lastViewedAtstringrequirednullable- The last time the client opened it (UTC).
lastClientActivityAtstringrequirednullable- The client's last answer (UTC) — compare with your system's last read.
createdAtstringrequirednullable- When the board was created (UTC).
updatedAtstringrequirednullable- Last change (UTC).