FairePlace

FairePlace Leases API

Lease management

GitHub OpenAPI

Operations 130

GET /lessee/leases List all leases where the user is a tenant #
GET /lessee/leases/pending-signatures List leases pending signature for the tenant #
GET /lessee/leases/{id} Get details of a specific lease for the tenant #
GET /lessee/leases/{id}/signature/status Get signature status of a lease for the tenant #
POST /lessee/leases/{id}/signature/sign Sign a lease as a tenant #
GET /lessee/leases/{id}/pdf Download the signed lease (PDF) #
POST /leases/{lease_id}/lessees Associate a lessee with a lease #
GET /leases/{lease_id}/lessees List lessees associated with a lease #
GET /leases/{lease_id}/lessees/active List active lessees for a lease #
GET /leases/{lease_id}/lessees/{lessee_id} Get a lease-lessee association #
PUT /leases/{lease_id}/lessees/{lessee_id} Update a lease-lessee association #
DELETE /leases/{lease_id}/lessees/{lessee_id} Delete a lease-lessee association #
PUT /leases/{lease_id}/lessees/{lessee_id}/end End a lessee's term #
POST /leases Create a lease #
GET /leases List all leases #
GET /leases/{lease_id} Get lease #
PUT /leases/{lease_id} Update lease #
DELETE /leases/{lease_id} Delete lease #
PUT /leases/{lease_id}/status Change lease status #
PUT /leases/{lease_id}/rent Update lease rent #
GET /leases/{lease_id}/compliance Check legal compliance of a lease #
GET /leases/estate/{estate_id} List leases for a property #
POST /leases/{lease_id}/compliance/update Check and apply legal compliance #
GET /leases/{lease_id}/template-data Expose Typst template data #
POST /leases/{lease_id}/documents Add a document to a lease #
GET /leases/{lease_id}/documents List lease documents #
GET /leases/{lease_id}/documents/{document_id} Get lease document #
PUT /leases/{lease_id}/documents/{document_id} Update lease document #
DELETE /leases/{lease_id}/documents/{document_id} Delete a document associated with a lease #
POST /leases/{lease_id}/amendments Create a lease amendment #
GET /leases/{lease_id}/amendments List lease amendments #
GET /leases/{lease_id}/amendments/{amendment_id} Get a lease amendment #
PUT /leases/{lease_id}/amendments/{amendment_id} Update a lease amendment #
DELETE /leases/{lease_id}/amendments/{amendment_id} Delete a lease amendment #
PUT /leases/{lease_id}/amendments/{amendment_id}/status Change amendment status #
POST /leases/{lease_id}/amendments/{amendment_id}/generate-pdf Generate amendment PDF #
POST /leases/{lease_id}/amendments/{amendment_id}/initiate-signature Initiate amendment electronic signature #
POST /leases/{lease_id}/amendments/{amendment_id}/finalize-signature Finalize amendment signature #
POST /leases/{lease_id}/deposit Record a security deposit #
GET /leases/{lease_id}/deposit Get security deposit details #
DELETE /leases/{lease_id}/deposit Delete a security deposit #
POST /leases/{lease_id}/deposit/return Return a security deposit #
POST /leases/{lease_id}/receipts/generate Generate rent receipts #
GET /leases/{lease_id}/receipts List rent receipts #
GET /leases/{lease_id}/receipts/{receipt_id} Get a rent receipt #
DELETE /leases/{lease_id}/receipts/{receipt_id} Delete a rent receipt #
GET /leases/{lease_id}/receipts/{receipt_id}/pdf Download rent receipt PDF #
POST /leases/{lease_id}/charges Create a lease charge #
GET /leases/{lease_id}/charges List charges of a lease #
GET /leases/{lease_id}/charges/{charge_id} Get lease charge #
PUT /leases/{lease_id}/charges/{charge_id} Update lease charge #
DELETE /leases/{lease_id}/charges/{charge_id} Delete a lease charge #
POST /leases/{lease_id}/charges/{charge_id}/regularize Regularize charge #
POST /leases/{lease_id}/charges/finalize Bulk end-of-lease charge regularization #
GET /leases/{lease_id}/charges/reviews List charge reviews #
POST /leases/{lease_id}/charges/reviews Create a charge review #
GET /leases/{lease_id}/charges/reviews/{review_id} Get a charge review #
PUT /leases/{lease_id}/charges/reviews/{review_id} Update a charge review #
DELETE /leases/{lease_id}/charges/reviews/{review_id} Delete a charge review #
POST /leases/{lease_id}/charges/reviews/{review_id}/transition Transition review status #
GET /leases/{lease_id}/charges/reviews/{review_id}/details List review details #
POST /leases/{lease_id}/charges/reviews/{review_id}/details Create a review detail #
GET /leases/{lease_id}/charges/reviews/{review_id}/details/{detail_id} Get a review detail #
PUT /leases/{lease_id}/charges/reviews/{review_id}/details/{detail_id} Update a review detail #
DELETE /leases/{lease_id}/charges/reviews/{review_id}/details/{detail_id} Delete a review detail #
GET /leases/{lease_id}/charges/documents List charge legal documents #
POST /leases/{lease_id}/charges/documents Create a charge legal document #
GET /leases/{lease_id}/charges/documents/{doc_id} Get a charge legal document #
PUT /leases/{lease_id}/charges/documents/{doc_id} Update a charge legal document #
DELETE /leases/{lease_id}/charges/documents/{doc_id} Delete a charge legal document #
GET /leases/{lease_id}/charges/notifications List charge notifications #
POST /leases/{lease_id}/charges/notifications Create a charge notification #
GET /leases/{lease_id}/charges/notifications/{notification_id} Get a charge notification #
PUT /leases/{lease_id}/charges/notifications/{notification_id} Update a charge notification #
DELETE /leases/{lease_id}/charges/notifications/{notification_id} Delete a charge notification #
GET /leases/{lease_id}/charges/{charge_id}/regulations List charge regulations #
POST /leases/{lease_id}/charges/{charge_id}/regulations Create a charge regulation #
GET /leases/{lease_id}/charges/{charge_id}/regulations/{regulation_id} Get a charge regulation #
PUT /leases/{lease_id}/charges/{charge_id}/regulations/{regulation_id} Update a charge regulation #
DELETE /leases/{lease_id}/charges/{charge_id}/regulations/{regulation_id} Delete a charge regulation #
GET /leases/{lease_id}/charges/{charge_id}/audit-log List charge audit log entries #
GET /leases/{lease_id}/charges/{charge_id}/meters List charge meters #
POST /leases/{lease_id}/charges/{charge_id}/meters Create a charge meter #
GET /leases/{lease_id}/charges/{charge_id}/meters/{id} Get a charge meter #
PUT /leases/{lease_id}/charges/{charge_id}/meters/{id} Update a charge meter #
DELETE /leases/{lease_id}/charges/{charge_id}/meters/{id} Delete a charge meter #
POST /leases/{lease_id}/charges/{charge_id}/calculate-meter Calculate meter-based charge #
GET /leases/{lease_id}/meters List lease meters #
POST /leases/{lease_id}/meters Create a lease meter #
GET /leases/{lease_id}/meters/{id} Get a lease meter #
PUT /leases/{lease_id}/meters/{id} Update a lease meter #
DELETE /leases/{lease_id}/meters/{id} Delete a lease meter #
POST /leases/{lease_id}/pdf Generate a lease PDF #
GET /leases/{lease_id}/pdfs List lease PDFs #
GET /leases/pdf/{pdf_id} Download a lease PDF #
DELETE /leases/pdf/{pdf_id} Delete a lease PDF #
GET /leases/signatures/document/{document_signature_id}/status Status of a specific document #
GET /leases/signatures/pending List all contracts pending signature #
GET /leases/signatures/contracts/{document_signature_id} Signature contract details #
POST /leases/signatures/request Request a signature (send OTP) - Global route #
POST /leases/signatures/events/process Process a signature event #
POST /leases/{lease_id}/signature/initiate Initiate signature for a specific lease #
GET /leases/{lease_id}/signature/status Signature status of a lease #
GET /leases/{lease_id}/signature/document/{document_signature_id}/status Status of a specific signature document #
POST /leases/{lease_id}/signature/request Request a signature - Send an OTP via SMS #
POST /leases/{lease_id}/signature/validate-otp Validate OTP and apply electronic signature #
POST /leases/{lease_id}/signature/events/process Process a signature event for a lease #
DELETE /leases/{lease_id}/signature/cancel Cancel a signature request #
DELETE /leases/{lease_id}/signature/reset Fully reset a signature #
POST /leases/{lease_id}/signature/resend/{signer_type} Resend signature request for a signer #
GET /leases/{lease_id}/signature/proof Get eIDAS signature proof #
POST /leases/{lease_id}/payment/create-intent Create a payment intent for a lease #
POST /leases/{lease_id}/payment/create-checkout-session Create Stripe Checkout session #
POST /leases/{lease_id}/payment/confirm-with-session Confirm payment with Stripe session #
GET /leases/{lease_id}/payment/signature-status Payment status for lease signing #
POST /leases/ingest-draft Ingest a public bail draft #
GET /leases/{lease_id}/signature/preflight Check whether a lease can be sent for signature #
GET /leases/{lease_id}/signature/documents/{document_signature_id}/proof Get the eIDAS proof of a designated signed document #
POST /leases/{lease_id}/annexes/missing-docs-attestation Attest that mandatory annexes were handed over off-platform #
PUT /leases/{lease_id}/lessees/{lessee_id}/consent Set a tenant's consent to electronic delivery #
POST /leases/{lease_id}/lessees/{lessee_id}/invite Invite a tenant to their FairePlace portal #
POST /leases/{lease_id}/lessees/{lessee_id}/request-consent Ask a tenant for their consent to email delivery #
POST /leases/{lease_id}/receipts/{receipt_id}/send Send a rent receipt to the tenant by email #
POST /leases/{lease_id}/receipts/{receipt_id}/regenerate-pdf Rebuild the PDF of an existing rent receipt #
GET /leases/{lease_id}/quittance-workflow Read the rent-receipt automation switch of a lease #
PATCH /leases/{lease_id}/quittance-workflow Turn the rent-receipt automation on or off for a lease #
GET /lessees/{id}/leases List the leases of a tenant #
GET /rent-status Monthly rent tracking across all active leases #
POST /leases/quick-setup Mettre en place une location déjà en cours #
POST /leases/{lease_id}/rent-confirm Confirmer la réception du loyer depuis l'application #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/faireplace-com/openapi/faireplace-com-leases-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/faireplace-com:faireplace-com-leases-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

faireplace-com-leases-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: FairePlace Property Management Leases API
  description: 'Comprehensive API for managing properties, leases, tenants, and all aspects of real estate management.

    Built with Rust and Actix-web following hexagonal architecture principles.


    ## Authentication

    This API uses API keys for authentication with tenant-based isolation.


    ## Base URL

    - Production: `https://api.faireplace.com/api`'
  version: 1.0.0
  contact:
    name: FairePlace API Support
    email: api-support@faireplace.com
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
- url: https://api.faireplace.com/api
  description: Production server
security:
- BearerAuth: []
tags:


# --- truncated at 32 KB (493 KB total) ---
# Full source: https://artifacts.apis.io/faireplace-com/openapi/faireplace-com-leases-api-openapi.yml