ELeliseai
Properties v2

List properties

Changed on

Returns a paginated list of properties accessible to your integration.

Use this endpoint to discover available properties and their basic information. Filter by active/inactive status to find specific properties.

Access Control: You will only see properties that your API credentials have been granted access to. Contact your account manager to request access to additional properties.

get/v2/properties

Request

  • Base URL
    https://api.eliseai.com
  • URL
    https://api.eliseai.com/v2/properties
  • Auth
    none declared

Query parameters

limitinteger

Number of properties to return (max 500)

active_onlyboolean

Whether to return only active properties

cursorstring

Pagination cursor from previous response. Use the next_cursor value from the previous response to get the next page.

organization_idstring

Optional filter to include only properties within a given organization

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,
      "external_ids": [
        {
          "source": "YardiVoyager",
          "id_type": "property",
          "external_id": "12345"
        }
      ],
      "buildings": []
    }
  ],
  "pagination": {
    "next_cursor": "a3naIad30=",
    "has_more": true
  }
}

Changes

  • b4ebf60d6d89Revision changes
    • info

      added the optional property // to the response with the status

  • ce0a43017b09Revision changes
    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status