tenants

Liste les baux des biens accessibles au compte authentifié.

Seuls les baux actifs sont renvoyés, sauf indication contraire via le filtre status. Le filtre property_id restreint aux baux d'un bien.

get/api/v1/tenants

Request

  • Base URL: https://api.qalimo.fr
  • URL: https://api.qalimo.fr/api/v1/tenants
  • Auth: HTTP bearer

Query parameters

statusstring[]

États à inclure, séparés par des virgules (ex. active,archived). Par défaut : active.

property_idinteger nullable

Restreint aux baux du bien donné.

Response

OK

idinteger required

Identifiant du bail.

namestring required

Libellé du bail.

occupantsstring required

Nom d'affichage des occupants.

property_idinteger required

Identifiant du bien loué.

start_datestring date required

Date de début du bail.

end_datestring date nullable

Date de fin du bail (null si non renseignée).

rent_excluding_chargesnumber nullable

Loyer hors charges, complément de loyer inclus.

status'active' | 'candidate' | 'archived' | 'archived_candidate' required

État du bail (actif, candidat, archivé, candidat archivé).

Changes

No recorded changes to this operation across all 1 revision of this API.