Lessees

List lessees of a given category

Filters on the tenant's category: the same field you set when creating a lessee, not on their role in a lease. A tenant's role (primary, co-tenant, guarantor) lives on the lease ↔ lessee association and is filtered through GET /leases/{lease_id}/lessees instead.

company/other contains a slash, so it must be percent-encoded in the path: /lessees/type/company%2Fother.

get/lessees/type/{type}

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/lessees/type/{type}
  • Auth: HTTP bearer

Path parameters

type'individual' | 'company/other' | 'guarantor' required

Lessee category

Example:individual

Lessee category. Percent-encode company/other as company%2Fother.

Response

Lessee list for the specified type

totalinteger required

Total number of lessees

pageinteger required

Current page number

limitinteger required

Number of items per page

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "category": "individual",
      "title": "M.",
      "first_name": "Jean",
      "last_name": "Dupont",
      "legal_name": "SARL Dupont & Associés",
      "birth_date": "1985-03-15",
      "birth_place": "Paris",
      "email": "jean.dupont@example.com",
      "mobile_phone": "+33 6 12 34 56 78",
      "landline_phone": "+33 1 23 45 67 89",
      "address_country": "France",
      "address_complement": "Appartement 12",
      "address_street_number": "123",
      "address_street_name": "rue de la Paix",
      "address_locality": "1er arrondissement",
      "address_postal_code": "75001",
      "address_city": "Paris",
      "address_postal_box": "123",
      "profession": "Ingénieur",
      "employer_name": "TechCorp SAS",
      "employer_phone": "+33 1 98 76 54 32",
      "monthly_income": 3500,
      "other_income": 500,
      "bank_name": "Crédit Agricole",
      "iban": "FR76 1234 5678 9012 3456 7890 123",
      "bic": "AGRIFRPP",
      "additional_addresses": {
        "work": "456 avenue des Champs-Élysées, 75008 Paris"
      },
      "identity_documents": {
        "passport": "12AB34567",
        "id_card": "123456789"
      },
      "additional_contacts": {
        "emergency": "+33 6 98 76 54 32",
        "family": "+33 1 11 22 33 44"
      },
      "custom_fields": {
        "preferred_language": "fr",
        "special_needs": "wheelchair access"
      },
      "auth_user_id": "user_123456789",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "total": 10,
  "page": 1,
  "limit": 20
}

Changes

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