Sign in

v7

latestOpenAPI 3.1.02026-08-0431138164.3 KB
Properties v2

Look up properties by external system ID

Resolves a partner system's property id (e.g. RentCafe, Entrata, Knock) to the Elise properties that match. For RentCafe, external_id must be numeric and is matched against the building's pricing/availability source; other systems match against the building's external CRM id scoped to that configured source. Results are filtered to production buildings (active, launched, non-test) with test-named buildings sorted last; buildings outside your access scope are silently dropped, and the endpoint returns 404 if nothing remains.

get/v2/properties/lookup

Query parameters

system'RentCafe' | 'YardiVoyager' | 'Entrata' | 'ResMan' | 'RealPage' | 'AppFolio' | 'Knock' | 'Funnel' required

External systems accepted by the property-lookup endpoint.

Lookup paths:

  • RentCafe — matched against building_pricing_avails_config.source_specific_config['RentCafe'].rent_cafe_property_ids (used by Yardi syndication partners that only know the RentCafe property id).

  • YardiVoyager, Entrata, ResMan, RealPage, AppFolio — matched against the union of two paths:

    • building_details.external_crm_id → filtered to candidates whose effective CRM (get_crm_setup) matches the requested system. For YardiVoyager the CRM-side identity is RentCafe (Yardi's leasing front-end); for RealPage it is ILM.
    • building_details.external_ids (text[]) → filtered to candidates whose effective PMS (get_pms_setup) matches the requested system.

  • Knock, Funnel — CRM-only systems. Matched against building_details.external_crm_id and filtered by effective CRM type (no PMS-side lookup is performed for these).

External system that owns the id being looked up

external_idstring required

The external system's identifier for the property

The external system's identifier for the property

Response

Successful Response

Example response

{
  "properties": [
    {
      "id": "12345",
      "name": "Sunrise Apartments",
      "property_type": "multi_family",
      "status": "active",
      "address": {
        "street_address": "123 Main Street",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94105",
        "country": "US"
      },
      "total_units": 250,
      "organization_id": "6789",
      "ils_email": "sunrise.12345@leads.eliseai.com"
    }
  ]
}