Candidates





Base URL

https://api.rentila.com/landlord/candidates

Endpoints

1. Get Filters

Endpoint:
GET https://api.rentila.com/landlord/candidates/filters
Description: Returns filters available for candidate's searches, such as landlords, properties, and buildings.
Response Example:
{
  "code": 200,
  "status": "success",
  "data": {
    "landlords": {
      "888279": "Immotop.lu"
    },
    "buildings": {
      "b61853": "IMEEEUBLLE1"
    },
    "properties": {
      "11": "22 rue Georges Bizet VENDU"
    }
  },
  "message": "OK"
}


2. Get Candidates

Endpoint:
GET https://api.rentila.com/landlord/candidates
Description: Retrieves a list of candidate tenants or a specific candidate by ID.
Query Parameters:
  • id (optional, integer) - ID of a specific candidate to retrieve.
  • filter (optional, object) - Filtering criteria.
  • sort_by (optional, string) - Sorting field.
  • sort_order (optional, string) - Sorting order (ASC or DESC).
  • page (optional, integer) - Page number.
  • show_per_page (optional, integer) - Number of results per page.
Response Example:
{
  "code": 200,
  "status": "success",
  "data": {
    "candidates": [
      {
        "TenantsCandidatureID": 12345,
        "Tenant": {
          "TenantID": 6789,
          "TenantName": "John Doe",
          "TenantEmail": "johndoe@example.com"
        },
        "Property": {
          "PropertyID": 11,
          "PropertyTitle": "22 rue Georges Bizet VENDU"
        },
        "Status": "New"
      }
    ],
    "status": {
      "new": 1,
      "waiting": 1,
      "accepted": 0,
      "confirmed": 0,
      "rejected": 0
    },
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "total_records": 1
    }
  },
  "message": "OK"
}