Skip to main content

Overview

The Flatbay integration enables your voice agents to search rental property listings and create candidate applications in real-time during calls. Perfect for real estate agencies using Flatbay as their rental management system.
This integration requires an active Flatbay account with API access. Contact Flatbay to obtain your API key.

What You Can Do

Setup

1

Get API Credentials

Contact Flatbay to obtain your API key and establishment ID
2

Add Integration

Go to Integrations and click Add Flatbay, then enter your API key and establishment ID
3

Test Connection

Click Test to verify your credentials work

Available Tools

Search properties by keyword (city, address, postal code) and transaction type (rental or sale).

Property Details

Retrieve detailed information about a specific property: address, surface, rent, deposit, charges, DPE rating, furnished status, and visit booking URL.

Create Application

Create a candidate application on a property. The agent collects the caller’s first name, last name, email, and phone number before submitting.

Example Conversation

Caller: I’m looking for a 2-bedroom apartment in Lyon.Agent: Let me search for you… I found 3 apartments in Lyon. The first is a 55 square meter apartment with 2 bedrooms in Lyon 6th, for 850 euros per month, DPE C. Would you like more details?Caller: Yes, tell me more about that one.Agent: This apartment is located on the 3rd floor with elevator, it has a balcony, the deposit is 850 euros, and charges are 50 euros per month. A visit can be booked online. Would you like to apply?Caller: Yes please!Agent: I’ll need your first name, last name, email, and phone number to create your application.

Troubleshooting