> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tala-assistant.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Flatbay

> Search rental properties and create applications during voice calls

## 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.

<Note>
  This integration requires an active Flatbay account with API access.
  Contact Flatbay to obtain your API key.
</Note>

## What You Can Do

| Feature                | Description                                               |
| ---------------------- | --------------------------------------------------------- |
| **Property Search**    | Find rental or sale listings matching caller criteria     |
| **Property Details**   | Get full details including price, surface, DPE, visit URL |
| **Create Application** | Submit a candidate application on behalf of the caller    |

## Setup

<Steps>
  <Step title="Get API Credentials">
    Contact Flatbay to obtain your API key and establishment ID
  </Step>

  <Step title="Add Integration">
    Go to **Integrations** and click **Add Flatbay**, then enter your API key and establishment ID
  </Step>

  <Step title="Test Connection">
    Click **Test** to verify your credentials work
  </Step>
</Steps>

## Available Tools

### Property Search

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

<AccordionGroup>
  <Accordion title="Rental property search">
    **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.
  </Accordion>
</AccordionGroup>

## Troubleshooting

| Issue                 | Solution                                                     |
| --------------------- | ------------------------------------------------------------ |
| Connection test fails | Verify your API key and establishment ID with Flatbay        |
| No properties found   | Check that properties are published in your Flatbay account  |
| Application fails     | Ensure all required fields (name, email, phone) are provided |