Browse the documentation

CRM

Each client's follow-up: contacts, next step, temperature, visits, offers, sales and each property's owner. Reading always works; recording requires the CRM module on the account.

Routes

GET/v1/leads/{leadId}/visits

The client's visits

The client's visits, newest first (up to 200). Works even without the CRM on: what was recorded stays readable.

Permission: crm:read

Path parameters

leadIdstringrequired
Client id (lead-…).

Response200OK

datalist of Visitrequired
The visits.
nextCursorstringrequirednullable
Next page cursor (null = done).

Example

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

Errors for this route

And the errors common to every route

GET/v1/properties/{propertyId}/visits

The property's visits

Visits to the property, from every client, newest first. A partner buyer's visit comes without their broker's note.

Permission: crm:read

Path parameters

propertyIdstringrequired
Property id (prop-…).

Response200OK

datalist of Visitrequired
The visits.
nextCursorstringrequirednullable
Next page cursor (null = done).

Example

curl -X GET 'https://api.imobyflow.com.br/v1/properties/prop-3f9a1c2b7d4e/visits' \
  -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}/proposals

The client's offers

The client's offers, with the negotiation rounds, newest first.

Permission: crm:read

Path parameters

leadIdstringrequired
Client id (lead-…).

Response200OK

datalist of Proposalrequired
The offers.
nextCursorstringrequirednullable
Next page cursor (null = done).

Example

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

Errors for this route

And the errors common to every route

GET/v1/properties/{propertyId}/proposals

The property's offers

Offers received for the property, from every client.

Permission: crm:read

Path parameters

propertyIdstringrequired
Property id (prop-…).

Response200OK

datalist of Proposalrequired
The offers.
nextCursorstringrequirednullable
Next page cursor (null = done).

Example

curl -X GET 'https://api.imobyflow.com.br/v1/properties/prop-3f9a1c2b7d4e/proposals' \
  -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}/sales

The client's sales

Sales and rentals closed with the client, with the commission split. Read-only: recording a sale happens in the dashboard.

Permission: crm:read

Path parameters

leadIdstringrequired
Client id (lead-…).

Response200OK

datalist of Salerequired
The sales.
nextCursorstringrequirednullable
Next page cursor (null = done).

Example

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

Errors for this route

And the errors common to every route

GET/v1/properties/{propertyId}/sales

The property's sales

The property's closed sales and rentals, with the commission split.

Permission: crm:read

Path parameters

propertyIdstringrequired
Property id (prop-…).

Response200OK

datalist of Salerequired
The sales.
nextCursorstringrequirednullable
Next page cursor (null = done).

Example

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

Errors for this route

And the errors common to every route

GET/v1/properties/{propertyId}/owner

The property's owner

The owners and the listing authorization: when it was signed, until when it is valid, exclusivity and the agreed commission. Without the PIX key, bank account and full personal data.

Permission: crm:read

Path parameters

propertyIdstringrequired
Property id (prop-…).

Response200OK

dataPropertyOwnerCardrequired
The card.

Example

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

Errors for this route

And the errors common to every route

PUT/v1/properties/{propertyId}/owner

Save the owner

Replaces the owner card: the owner list and the authorization. What does not come is left empty — except each owner's PIX key, bank account and personal data, which the API does not see and keeps (matched by CPF/CNPJ or, without one, by name). Requires the CRM (or Rentals) module on.

Permission: crm:writeSupports dry runSupports Idempotency-Key

Path parameters

propertyIdstringrequired
Property id (prop-…).

Query parameters

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

Request body

ownerslist of OwnerPersonInputrequired
1 to 10 owners. Replaces the list.
authSignedOnstring
Authorization signed on (2026-11-20).
authValidUntilstring
Authorization valid until (2027-05-20).
exclusiveboolean
Exclusive listing.
commissionPercentnumber
The agreed commission, in %.

Example body

{
  "owners": [
    {
      "name": "João Almeida",
      "phone": "41988887777",
      "document": "12345678909",
      "sharePercent": 100
    }
  ],
  "authSignedOn": "2026-10-01",
  "authValidUntil": "2027-04-01",
  "exclusive": true,
  "commissionPercent": 6
}

Response200OK201 when it creates the card.

dataPropertyOwnerCardrequired
The object as it now stands.
resultCrmWriteResultrequired
The outcome.

Example

# Dry run: nothing is written. Remove ?dryRun=true to write for real.
curl -X PUT 'https://api.imobyflow.com.br/v1/properties/prop-3f9a1c2b7d4e/owner?dryRun=true' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "owners": [
    {
      "name": "João Almeida",
      "phone": "41988887777",
      "document": "12345678909",
      "sharePercent": 100
    }
  ],
  "authSignedOn": "2026-10-01",
  "authValidUntil": "2027-04-01",
  "exclusive": true,
  "commissionPercent": 6
}
JSON

Errors for this route

And the errors common to every route

POST/v1/leads/{leadId}/contacts

Log how the contact went

The dashboard's "How did the contact go?" in one request: the answer, the note and the next step. The answer sets the temperature (unless someone locked it) and moves the client out of New. GAVE_UP closes as Lost and requires lostReason. Replaces POST /leads/{leadId}/interactions with CONTACT for accounts with the CRM.

Permission: crm:writeSupports dry runSupports Idempotency-Key

Path parameters

leadIdstringrequired
Client id (lead-…).

Query parameters

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

Request body

outcomestringrequired
How it went.one of THINKING FAMILY FINANCING WANTS_VISIT MORE_OPTIONS DISLIKED NO_ANSWER GAVE_UP
notestring
Note.
nextStepDuestring
Next step: the day (2026-11-21) or day and time (2026-11-21T14:30), São Paulo time. Without it, the next step is cleared.
nextStepTitlestring
What to do at the next step.
lostReasonstring
Why it was lost (required with GAVE_UP).one of BOUGHT_ELSEWHERE GAVE_UP_BUYING CREDIT_DENIED NOT_FOUND STOPPED_ANSWERING OTHER
lostNotestring
Loss note.

Example body

{
  "outcome": "WANTS_VISIT",
  "note": "Quer ver o AP1234 no sábado.",
  "nextStepDue": "2026-11-21T10:00",
  "nextStepTitle": "Confirmar a visita"
}

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/contacts?dryRun=true' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "outcome": "WANTS_VISIT",
  "note": "Quer ver o AP1234 no sábado.",
  "nextStepDue": "2026-11-21T10:00",
  "nextStepTitle": "Confirmar a visita"
}
JSON

Errors for this route

And the errors common to every route

POST/v1/leads/{leadId}/next-step

Set the next step

Sets or replaces the next step, without logging a contact. due: null clears it. One per client: the new one replaces the previous.

Permission: crm:writeSupports dry runSupports Idempotency-Key

Path parameters

leadIdstringrequired
Client id (lead-…).

Query parameters

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

Request body

duestringrequirednullable
The day (2026-11-21) or day and time (2026-11-21T14:30), São Paulo time — from today up to one year.
titlestring
What to do (default: "Retomar o contato").

Example body

{
  "due": "2026-11-24",
  "title": "Mandar as opções no Bigorrilho"
}

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/next-step?dryRun=true' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "due": "2026-11-24",
  "title": "Mandar as opções no Bigorrilho"
}
JSON

Errors for this route

And the errors common to every route

POST/v1/leads/{leadId}/temperature

Lock the temperature

Locks the temperature by hand (HOT, WARM, COLD): contact answers stop changing it. temperature: null returns it to automatic.

Permission: crm:writeSupports dry runSupports Idempotency-Key

Path parameters

leadIdstringrequired
Client id (lead-…).

Query parameters

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

Request body

temperaturestringrequirednullable
The temperature.one of HOT WARM COLD

Example body

{
  "temperature": "HOT"
}

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/temperature?dryRun=true' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "temperature": "HOT"
}
JSON

Errors for this route

And the errors common to every route

POST/v1/leads/{leadId}/lost

Close as lost

Moves the client to Lost, with the reason; the next step is cleared. The client's open partnerships are NOT closed through the API — the dashboard warns the team.

Permission: crm:writeSupports dry runSupports Idempotency-Key

Path parameters

leadIdstringrequired
Client id (lead-…).

Query parameters

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

Request body

reasonstringrequired
The reason.one of BOUGHT_ELSEWHERE GAVE_UP_BUYING CREDIT_DENIED NOT_FOUND STOPPED_ANSWERING OTHER
notestring
Note.

Example body

{
  "reason": "BOUGHT_ELSEWHERE",
  "note": "Fechou com a construtora direto."
}

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/lost?dryRun=true' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "reason": "BOUGHT_ELSEWHERE",
  "note": "Fechou com a construtora direto."
}
JSON

Errors for this route

And the errors common to every route

POST/v1/leads/{leadId}/visits

Schedule a visit

Schedules the client's visit to a property in the portfolio (or a partner's, with an open partnership). It becomes the next step, makes the client Hot and shows up in the broker's day.

Permission: crm:writeSupports dry runSupports Idempotency-Key

Path parameters

leadIdstringrequired
Client id (lead-…).

Query parameters

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

Request body

propertyIdstringrequired
The property.
scheduledAtstringrequired
Day and time, São Paulo time (2026-11-21T10:00) — from today up to one year.
brokerAccountIdstring
Who goes with the client (default: the client's broker). Must be on the team.

Example body

{
  "propertyId": "prop-3f9a1c2b7d4e",
  "scheduledAt": "2026-11-21T10:00"
}

Response201Created

dataVisitrequired
The object as it now stands.
resultCrmWriteResultrequired
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/visits?dryRun=true' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "propertyId": "prop-3f9a1c2b7d4e",
  "scheduledAt": "2026-11-21T10:00"
}
JSON

Errors for this route

And the errors common to every route

POST/v1/visits/{visitId}/reschedule

Reschedule the visit

Changes the day and time of a scheduled visit.

Permission: crm:writeSupports dry runSupports Idempotency-Key

Path parameters

visitIdstringrequired
Visit id (vis-…).

Query parameters

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

Request body

scheduledAtstringrequired
Day and time, São Paulo time (2026-11-22T15:00).

Example body

{
  "scheduledAt": "2026-11-22T15:00"
}

Response200OK

dataVisitrequired
The object as it now stands.
resultCrmWriteResultrequired
The outcome.

Example

# Dry run: nothing is written. Remove ?dryRun=true to write for real.
curl -X POST 'https://api.imobyflow.com.br/v1/visits/visitId/reschedule?dryRun=true' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "scheduledAt": "2026-11-22T15:00"
}
JSON

Errors for this route

And the errors common to every route

POST/v1/visits/{visitId}/cancel

Cancel the visit

Cancels a scheduled visit; the cancellation goes into the client's history.

Permission: crm:writeSupports dry runSupports Idempotency-Key

Path parameters

visitIdstringrequired
Visit id (vis-…).

Query parameters

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

Request body

notestring
The reason.

Example body

{
  "note": "O cliente viajou."
}

Response200OK

dataVisitrequired
The object as it now stands.
resultCrmWriteResultrequired
The outcome.

Example

# Dry run: nothing is written. Remove ?dryRun=true to write for real.
curl -X POST 'https://api.imobyflow.com.br/v1/visits/visitId/cancel?dryRun=true' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "note": "O cliente viajou."
}
JSON

Errors for this route

And the errors common to every route

POST/v1/visits/{visitId}/outcome

Log how the visit went

The "How did the visit go?": done (with the client's impression) or NO_SHOW. Sets the temperature and the next step, as in the dashboard.

Permission: crm:writeSupports dry runSupports Idempotency-Key

Path parameters

visitIdstringrequired
Visit id (vis-…).

Query parameters

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

Request body

outcomestringrequired
How it went.one of WANTS_PROPOSAL WANTS_RETURN THINKING DISLIKED NO_SHOW
notestring
Note.
nextStepDuestring
Next step: the day or day and time, São Paulo time.
nextStepTitlestring
What to do.

Example body

{
  "outcome": "WANTS_PROPOSAL",
  "note": "Gostou da vista. Quer oferecer 850 mil.",
  "nextStepDue": "2026-11-22",
  "nextStepTitle": "Montar a proposta"
}

Response200OK

dataVisitrequired
The object as it now stands.
resultCrmWriteResultrequired
The outcome.

Example

# Dry run: nothing is written. Remove ?dryRun=true to write for real.
curl -X POST 'https://api.imobyflow.com.br/v1/visits/visitId/outcome?dryRun=true' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "outcome": "WANTS_PROPOSAL",
  "note": "Gostou da vista. Quer oferecer 850 mil.",
  "nextStepDue": "2026-11-22",
  "nextStepTitle": "Montar a proposta"
}
JSON

Errors for this route

And the errors common to every route

POST/v1/leads/{leadId}/proposals

Record an offer

The client's offer for a property: purchase (SALE, with payment methods and down payment) or rent (RENT, with guarantee and term). On a property for sale AND rent, kind is required. Moves the client to Proposal; on a partner's property, the partner agency is notified, as in the dashboard.

Permission: crm:writeSupports dry runSupports Idempotency-Key

Path parameters

leadIdstringrequired
Client id (lead-…).

Query parameters

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

Request body

propertyIdstringrequired
The property.
kindstring
SALE or RENT.one of SALE RENT
amountnumberrequired
The offered amount (for rent, the monthly rent).
paymentMethodslist of string
Payment methods (purchase).one of FINANCING FGTS CASH EXCHANGE CONSORTIUM
downPaymentnumber
Down payment (purchase) — cannot exceed the amount.
validUntilstring
Valid until (2026-11-30).
conditionsstring
Conditions.
rentGuaranteestring
Guarantee (rent).one of FIANCA CAUCAO SEGURO_FIANCA GARANTIA_DIGITAL TITULO NENHUMA
rentMonthsinteger
Term in months (rent).
rentStartOnstring
Desired start (rent).
nextStepDuestring
Next step: the day or day and time.
nextStepTitlestring
What to do.

Example body

{
  "propertyId": "prop-3f9a1c2b7d4e",
  "kind": "SALE",
  "amount": 850000,
  "paymentMethods": [
    "FINANCING",
    "FGTS"
  ],
  "downPayment": 170000,
  "validUntil": "2026-11-30",
  "conditions": "Escritura em 60 dias.",
  "nextStepDue": "2026-11-25",
  "nextStepTitle": "Cobrar a resposta"
}

Response201Created

dataProposalrequired
The object as it now stands.
resultCrmWriteResultrequired
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/proposals?dryRun=true' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "propertyId": "prop-3f9a1c2b7d4e",
  "kind": "SALE",
  "amount": 850000,
  "paymentMethods": [
    "FINANCING",
    "FGTS"
  ],
  "downPayment": 170000,
  "validUntil": "2026-11-30",
  "conditions": "Escritura em 60 dias.",
  "nextStepDue": "2026-11-25",
  "nextStepTitle": "Cobrar a resposta"
}
JSON

Errors for this route

And the errors common to every route

POST/v1/proposals/{proposalId}/rounds

Record a counteroffer

A new round on the same offer: from whom (CLIENT or OWNER) and how much. The offer's amount becomes this one.

Permission: crm:writeSupports dry runSupports Idempotency-Key

Path parameters

proposalIdstringrequired
Offer id (prp-…).

Query parameters

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

Request body

bystringrequired
From whom.one of CLIENT OWNER
amountnumberrequired
The amount.
notestring
Note.

Example body

{
  "by": "OWNER",
  "amount": 875000,
  "note": "Aceita 875 com escritura em 45 dias."
}

Response200OK

dataProposalrequired
The object as it now stands.
resultCrmWriteResultrequired
The outcome.

Example

# Dry run: nothing is written. Remove ?dryRun=true to write for real.
curl -X POST 'https://api.imobyflow.com.br/v1/proposals/proposalId/rounds?dryRun=true' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "by": "OWNER",
  "amount": 875000,
  "note": "Aceita 875 com escritura em 45 dias."
}
JSON

Errors for this route

And the errors common to every route

POST/v1/proposals/{proposalId}/close

Close the offer

The outcome: ACCEPTED, REJECTED, WITHDRAWN or EXPIRED. Except when accepted, the client goes back to In progress when they have no other open offer. Recording the SALE that follows an accepted offer happens in the dashboard (that is where the commission is split).

Permission: crm:writeSupports dry runSupports Idempotency-Key

Path parameters

proposalIdstringrequired
Offer id (prp-…).

Query parameters

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

Request body

outcomestringrequired
The outcome.one of ACCEPTED REJECTED WITHDRAWN EXPIRED
notestring
Note.
nextStepDuestring
Next step: the day or day and time.
nextStepTitlestring
What to do.

Example body

{
  "outcome": "ACCEPTED",
  "note": "Fechado em 875 mil."
}

Response200OK

dataProposalrequired
The object as it now stands.
resultCrmWriteResultrequired
The outcome.

Example

# Dry run: nothing is written. Remove ?dryRun=true to write for real.
curl -X POST 'https://api.imobyflow.com.br/v1/proposals/proposalId/close?dryRun=true' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "outcome": "ACCEPTED",
  "note": "Fechado em 875 mil."
}
JSON

Errors for this route

And the errors common to every route

Objects

CrmProperty

The property, as it was when the record was made.

titlestringrequirednullable
Listing title.
typestringrequirednullable
Subtype.
neighborhoodstringrequirednullable
Neighborhood.
citystringrequirednullable
City.

Visit

A CRM visit.

idstringrequirednullable
Visit id (vis-…). Null in the dry run of a new visit.
leadIdstringrequired
The client.
propertyIdstringrequired
The property.
brokerAccountIdstringrequirednullable
Who goes with the client.
scheduledAtstringrequired
Day and time, São Paulo time (2026-11-21T10:00).
statusstringrequired
SCHEDULED, DONE, NO_SHOW or CANCELLED.one of SCHEDULED DONE NO_SHOW CANCELLED
outcomestringrequirednullable
How it went.one of WANTS_PROPOSAL WANTS_RETURN THINKING DISLIKED NO_SHOW
notestringrequirednullable
The broker's note.
propertyCrmPropertyrequired
The property.
partnershipIdstringrequirednullable
The partnership, when the property belongs to a partner.
slipSignedAtstringrequirednullable
When the buyer signed the visit slip. The slip itself stays in the dashboard.
doneAtstringrequirednullable
When it was recorded as done.
createdAtstringrequirednullable
When it was created (UTC).
updatedAtstringrequirednullable
Last change (UTC).

ProposalRound

A negotiation round.

atstringrequired
When.
bystringrequired
CLIENT (the client offered) or OWNER (the owner countered).one of CLIENT OWNER
amountnumberrequired
The round amount.
notestringrequirednullable
Note.

Proposal

A CRM offer.

idstringrequirednullable
Offer id (prp-…). Null in the dry run of a new offer.
leadIdstringrequired
The client.
propertyIdstringrequired
The property.
brokerAccountIdstringrequirednullable
The client's broker.
kindstringrequired
SALE or RENT.one of SALE RENT
statusstringrequired
The status.one of OPEN ACCEPTED REJECTED WITHDRAWN EXPIRED SOLD FELL_THROUGH RENTED
amountnumberrequired
The current amount (the last round). For rent, the offered rent.
askingPricenumberrequirednullable
The listed price when the offer was made.
paymentMethodslist of stringrequired
Payment methods (purchase).one of FINANCING FGTS CASH EXCHANGE CONSORTIUM
downPaymentnumberrequirednullable
Down payment (purchase).
validUntilstringrequirednullable
Valid until (day).
conditionsstringrequirednullable
Conditions.
rentGuaranteestringrequirednullable
Guarantee (rent).one of FIANCA CAUCAO SEGURO_FIANCA GARANTIA_DIGITAL TITULO NENHUMA
rentMonthsintegerrequirednullable
Term in months (rent).
rentStartOnstringrequirednullable
Desired start (rent).
roundslist of ProposalRoundrequired
The rounds, first to last.
propertyCrmPropertyrequired
The property.
partnershipIdstringrequirednullable
The partnership, when the property belongs to a partner.
acceptedAtstringrequirednullable
When it was accepted.
reservedUntilstringrequirednullable
Reserved until (day), after acceptance.
closeNotestringrequirednullable
The closing note.
closedAtstringrequirednullable
When it was closed.
rentContractIdstringrequirednullable
The rental contract created from it.
createdAtstringrequirednullable
When it was created (UTC).
updatedAtstringrequirednullable
Last change (UTC).

SaleSplit

One part of the commission split.

accountIdstringrequired
Who receives.
namestringrequirednullable
Name.
roleslist of stringrequired
The roles in the sale.
percentnumberrequirednullable
The commission share.
valuenumberrequirednullable
The amount.

Sale

A sale (or rental) closed in the CRM. Read-only through the API: the commission split is recorded in the dashboard.

idstringrequired
Sale id.
leadIdstringrequired
The client.
propertyIdstringrequired
The property.
proposalIdstringrequirednullable
The accepted offer.
kindstringrequired
SALE or RENT.one of SALE RENT
statusstringrequired
The sale status (undone = UNDONE).
closedOnstringrequirednullable
The closing day.
amountnumberrequirednullable
The amount.
askingPricenumberrequirednullable
The listed price.
paymentMethodslist of stringrequired
Payment methods.
commissionPercentnumberrequirednullable
The commission percentage.
commissionTotalnumberrequirednullable
The total commission.
splitslist of SaleSplitrequired
The commission split.
partialbooleanrequired
Only part of the split belongs to this account (partnership sale).
propertyMarkedSoldbooleanrequired
The property was taken down as sold or rented.
propertyCrmPropertyrequired
The property.
createdAtstringrequirednullable
When it was created (UTC).
undoneAtstringrequirednullable
When it was undone.

OwnerPerson

An owner. Personal data: the agency is the controller.

namestringrequirednullable
Name.
phonestringrequirednullable
Phone.
emailstringrequirednullable
E-mail.
documentstringrequirednullable
CPF or CNPJ, formatted.
documentTypestringrequirednullable
CPF or CNPJ.
sharePercentnumberrequirednullable
Their share of the property, in %.

PropertyOwnerCard

The property's owner and the authorization. The PIX key, bank account and full personal data stay in the dashboard.

propertyIdstringrequired
The property.
existsbooleanrequired
The card has been filled in.
ownerslist of OwnerPersonrequired
The owners.
authSignedOnstringrequirednullable
Listing authorization signed on (day).
authValidUntilstringrequirednullable
Authorization valid until (day).
authStatusstringrequirednullable
NONE, VALID, EXPIRING (expires soon) or EXPIRED.one of NONE VALID EXPIRING EXPIRED
authDaysLeftintegerrequirednullable
Days until the authorization expires.
exclusivebooleanrequirednullable
Exclusive listing.
commissionPercentnumberrequirednullable
The commission agreed with the owner, in %.
updatedAtstringrequirednullable
Last change (UTC).

OwnerPersonInput

An owner.

namestring
Name. Required.
phonestring
Phone.
emailstring
E-mail.
documentstring
CPF or CNPJ.
sharePercentnumber
Their share, in %.

PropertyOwnerInput

The whole card. What does not come is left empty — except the PIX key, bank account and personal data of the owner, which the API neither sees nor erases.

ownerslist of OwnerPersonInputrequired
1 to 10 owners. Replaces the list.
authSignedOnstring
Authorization signed on (2026-11-20).
authValidUntilstring
Authorization valid until (2027-05-20).
exclusiveboolean
Exclusive listing.
commissionPercentnumber
The agreed commission, in %.

CrmWriteResult

The outcome of the write.

outcomestringrequired
What happened: RECORDED, UPDATED, CLEARED, CLOSED, SCHEDULED, ALREADY_SCHEDULED (the same visit was already scheduled — nothing was created), RESCHEDULED, CANCELLED, CREATED, ROUND_ADDED, MOVED.
dryRunbooleanrequired
It was a dry run — nothing was written and nobody was notified.