Skip to main content
Imobzi is a real estate management platform designed for property professionals. It provides tools for managing properties, clients, sales processes, and marketing campaigns to help real estate agents and agencies streamline their operations and grow their business.

​
Configuring Imobzi as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Imobzi option from the list of connectors. Click Next and you’ll be prompted to add your access.

​
1. Add account access

You’ll need to provide your API credentials to connect to Imobzi. Check Imobzi documentation to discover where you can find the API Key for the connection. The following configuration is available:
  • API Key: Your Imobzi API key for authentication and access to the platform’s data.
Once you’re done, click Next.

​
2. Select streams

Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.
Tip: The stream can be found more easily by typing its name.
Select the streams and click Next.

​
3. Configure data streams

Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.
  • Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
  • Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
  • Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
  • Sync Type: you can choose between INCREMENTAL and FULL_TABLE.
    • Incremental: every time the extraction happens, we’ll get only the new data - which is good if, for example, you want to keep every record ever fetched.
    • Full table: every time the extraction happens, we’ll get the current state of the data - which is good if, for example, you don’t want to have deleted data in your catalog.
Once you are done configuring, click Next.

​
4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can define some additional settings:
  • Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
  • Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.
Once you are ready, click Next to finalize the setup.

​
5. Check your new source

You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.
For you to be able to see it on your Catalog, you need at least one successful source run.

​
Streams and Fields

Below you’ll find all available data streams from Imobzi and their corresponding fields:
Stream for managing bank information and configurations.
FieldTypeDescription
db_idIntegerID intern of the bank in the database. Required for create
codeStringCode of the bank. Required for create
nameStringBank name. Required for create
logo_urlStringURL of the bank logo
idIntegerID intern or alternative ID of the bank in the database
Stream for managing contact bank account information.
FieldTypeDescription
contact_idStringContact ID from parent stream
bank_idStringUnique identifier of the bank
actionStringAction to be performed, such as create, update, or delete
idStringUnique identifier of the record
bank_nameStringName of the bank
organization_idStringUnique identifier of the organization associated with the bank account
person_idStringUnique identifier of the person associated with the bank account
accountStringBank account number
agencyStringBank branch (agency) number
account_typeStringType of the bank account. Can be ‘checking_account’ or ‘savings_account’
notesStringAdditional notes or remarks related to the bank account
Stream for managing real estate contracts and their details.
FieldTypeDescription
codeStringContract code
contract_typeStringContract type
keyStringContract key
db_idIntegerID intern of the contract in database
valueNumberContract value
statusStringContract status. Enum: active, ended, suspended, in_review, in_progress, traveling
start_atStringContract start at date, in format ISO
contactsArrayContact list related to the contract
sourceStringSource of the contract
in_progressBooleanIndicates if the contract is in progress
insurancesArrayInsurances related to the contract
invoice_items_valueNumberValue of invoice items related to the contract
Stream for managing credit and financing analysis processes.
FieldTypeDescription
db_idIntegerID intern of the analysis in database
statusStringStatus of the analysis
typeStringType of analysis (e.g., ‘fc_analise’)
lease_valueNumberLease value
condominium_valueNumberCondominium value
iptu_valueNumberIPTU value
total_valueNumberTotal value
suitorsArrayList of suitors related to the analysis
leaseObjectLease information related to the analysis
Stream for managing deal filtering configurations and criteria.
FieldTypeDescription
idIntegerUnique identifier for the deal filter
nameStringName of the deal filter
descriptionStringDescription of the filter criteria
created_atStringFilter creation date
updated_atStringFilter last update date
activeBooleanIndicates if the filter is active
Stream for managing deal rotation processes and assignments.
FieldTypeDescription
idIntegerUnique identifier for the deal rotation
deal_idIntegerAssociated deal identifier
from_user_idIntegerUser ID from whom the deal is being rotated
to_user_idIntegerUser ID to whom the deal is being rotated
rotation_dateStringDate when the rotation occurred
reasonStringReason for the deal rotation
statusStringStatus of the rotation
Stream for managing document information and metadata.
FieldTypeDescription
idIntegerUnique identifier for the document
nameStringDocument name
typeStringDocument type
urlStringURL to access the document
created_atStringDocument creation date
updated_atStringDocument last update date
sizeIntegerDocument size in bytes
mime_typeStringMIME type of the document
Stream for managing financial account information and configurations.
FieldTypeDescription
idIntegerUnique identifier for the financial account
nameStringName of the financial account
typeStringType of financial account
balanceNumberCurrent account balance
currencyStringAccount currency
created_atStringAccount creation date
updated_atStringAccount last update date
activeBooleanIndicates if the account is active
Stream for managing contact tags and classifications.
FieldTypeDescription
idIntegerUnique identifier for the contact tag
nameStringName of the tag
colorStringColor associated with the tag
descriptionStringDescription of the tag
created_atStringTag creation date
Stream containing detailed information about deals.
FieldTypeDescription
idIntegerUnique identifier for the deal
titleStringDeal title
valueNumberDeal value
statusStringCurrent deal status
created_atStringDeal creation date
updated_atStringDeal last update date
expected_close_dateStringExpected closing date
Stream for reporting on completed deals.
FieldTypeDescription
deal_idIntegerUnique identifier for the completed deal
deal_titleStringTitle of the completed deal
completion_dateStringDate when the deal was completed
final_valueNumberFinal value of the completed deal
commissionNumberCommission earned from the deal
Stream containing a list of all deals.
FieldTypeDescription
idIntegerUnique identifier for the deal
titleStringDeal title
statusStringCurrent deal status
valueNumberDeal value
created_atStringDeal creation date
Stream for managing reasons why deals are lost.
FieldTypeDescription
idIntegerUnique identifier for the lost reason
nameStringName of the lost reason
descriptionStringDescription of the lost reason
activeBooleanIndicates if the reason is active
Stream for managing lease agreements and information.
FieldTypeDescription
idIntegerUnique identifier for the lease
property_idIntegerAssociated property identifier
tenant_idIntegerAssociated tenant identifier
start_dateStringLease start date
end_dateStringLease end date
monthly_rentNumberMonthly rent amount
Stream for managing media source information.
FieldTypeDescription
idIntegerUnique identifier for the media source
nameStringName of the media source
typeStringType of media source
urlStringURL of the media source
activeBooleanIndicates if the media source is active
Stream for managing pipeline group configurations.
FieldTypeDescription
idIntegerUnique identifier for the pipeline group
nameStringName of the pipeline group
descriptionStringDescription of the pipeline group
activeBooleanIndicates if the pipeline group is active
Stream for managing sales pipeline information.
FieldTypeDescription
idIntegerUnique identifier for the pipeline
nameStringName of the pipeline
stagesArrayPipeline stages configuration
activeBooleanIndicates if the pipeline is active
Stream containing contact information and details.
FieldTypeDescription
contact_idStringUnique identifier for the contact
nameStringContact name
emailStringContact email address
phoneStringContact phone number
contact_typeStringType of contact
created_atStringContact creation date
Stream containing property listings and information.
FieldTypeDescription
idIntegerUnique identifier for the property
titleStringProperty title
addressStringProperty address
priceNumberProperty price
typeStringProperty type
statusStringProperty status
Stream for managing financial transaction records.
FieldTypeDescription
idIntegerUnique identifier for the transaction
amountNumberTransaction amount
typeStringTransaction type
dateStringTransaction date
descriptionStringTransaction description
account_idIntegerAssociated account identifier
Stream for managing property reservation information.
FieldTypeDescription
idIntegerUnique identifier for the reservation
property_idIntegerAssociated property identifier
contact_idIntegerAssociated contact identifier
reservation_dateStringDate of reservation
statusStringReservation status
Stream containing detailed property information.
FieldTypeDescription
idIntegerUnique identifier for the property
titleStringProperty title
descriptionStringProperty description
specificationsObjectDetailed property specifications
amenitiesArrayList of property amenities
locationObjectProperty location details

​
Data Model

The following diagram illustrates the relationships between the core data streams in Imobzi:

​
Implementation Notes

​
Data Synchronization

  • Most streams support full table synchronization
  • Some streams like financial transactions may benefit from incremental sync to capture new transactions efficiently
  • Contact bank data is retrieved as a child stream of contacts, ensuring data consistency

​
API Considerations

  • The connector handles pagination automatically for large datasets
  • Rate limiting is managed internally to ensure stable data extraction
  • Parent-child relationships (like contacts and contact bank data) are properly maintained during sync

​
Skills for agents

Download Imobzi skills file

Imobzi connector documentation as plain markdown, for use in AI agent contexts.