🌐 Livble API Overview

Welcome to the Livble Partner API, which allows you to integrate seamlessly with Livble’s flexible rent platform.


πŸ”‘ Key Features

  • Sync tenant data – Send tenant details to Livble as part of the flexible rent integration.
  • Handle payments – Handle payments made by Livble to you on behalf tenants.
    (See the Flow of Funds and Settlements pages for more info)
  • Simulate flows – Test different tenant scenarios in our sandbox environment.

πŸ” API Reference

For a complete list of available endpoints and their request and response schemas,
visit the full API reference


🌍 API Environments

πŸ“˜

API Versioning

The latest API version is v2.
For all requests, append the version to the base URL.

Breaking changes will not be introduced within an existing API version.


πŸ”’ Authentication

Livble’s API uses Backend-to-Backend authentication with a shared API secret.
Each request must include an Authorization header with a Bearer token like so:

curl --request GET \
     --url https://api.partners.sandbox.nowlvble.com/v2/foo \
     --header 'authorization: Bearer $YOUR_API_KEY'
πŸ“˜

Your secret API key will be shared with you via a secure channel


⏰ Time formats

Livble uses date-time and date formats across the API. Please use the following formats:

date-time: ISO 8601 (Example: 2025-02-14T22:04:30.122885)

date: YYY-MM-DD (Example: 2025-02-14)