Introduction
Embedding
Webhooks
Applications API
Applicants API
Properties API
Floor Plans API
Warning: Only resources, actions, and attributes documented here should be considered public. Any undocumented resources, actions, or attributes should be considred private and may change at any time without notice. Be extra cautious of undocumented attributes since those are the most likely to change.

If you with to use a undocumented portion of the API, please contact us first so we can either a) document it and make it public or b) explain what planned changes are in store for that part of the API.

Floor Plans API

If you want to specify a rent amount for a property, you do so via a floor plan.

GET
/api/v2/properties/:property_id/floor_plans

Returns a list of floor plans for the specified property.

Example Response
{
  "floor_plans": [
    {
      "id": 73,
      "property_id": 66,
      "name": "Studio",
      "beds": 1,
      "baths": 1.5,
      "deposit": 600,
      "rent": 1200
    }
  ]
}