{
  "meta": {
    "offset": "integer",
    "limit": "integer",
    "orderBy": [
      {}
    ],
    "hasMore": [
      "boolean",
      "null"
    ],
    "total": "number"
  },
  "results": {
    "id": "string",
    "created_at": "string",
    "updated_at": "string",
    "x_id": "string",
    "x_property_id": "string",
    "x_unit_id": [
      "string",
      "null"
    ],
    "available_date": [
      "string",
      "null"
    ],
    "application_url": [
      "string",
      "null"
    ],
    "bathrooms": [
      "string",
      "null"
    ],
    "bedrooms": [
      "string",
      "null"
    ],
    "building_name": [
      "string",
      "null"
    ],
    "building_number": [
      "string",
      "null"
    ],
    "city": [
      "string",
      "null"
    ],
    "country": [
      "string",
      "null"
    ],
    "deposit_amount_in_cents": [
      "number",
      "null"
    ],
    "floor_plan_code": [
      "string",
      "null"
    ],
    "floor_plan_name": [
      "string",
      "null"
    ],
    "floor": [
      "string",
      "null"
    ],
    "image_urls": {},
    "is_available": [
      "boolean",
      "null"
    ],
    "is_furnished": [
      "boolean",
      "null"
    ],
    "is_listed": [
      "boolean",
      "null"
    ],
    "is_managed_external": [
      "boolean",
      "null"
    ],
    "is_vacant": [
      "boolean",
      "null"
    ],
    "lease_term": [
      "string",
      "null"
    ],
    "listing_date": [
      "string",
      "null"
    ],
    "notes": [
      "string",
      "null"
    ],
    "number": [
      "string",
      "null"
    ],
    "rent_amount_in_cents": [
      "number",
      "null"
    ],
    "square_feet": [
      "integer",
      "null"
    ],
    "state": [
      "string",
      "null"
    ],
    "street_address_1": [
      "string",
      "null"
    ],
    "street_address_2": [
      "string",
      "null"
    ],
    "address_1": [
      "string",
      "null"
    ],
    "address_2": [
      "string",
      "null"
    ],
    "zip": [
      "string",
      "null"
    ],
    "property_id": "string",
    "integration_id": "string",
    "integration_vendor": "string"
  }
}

​
Path Parameters

idrequired
string

The ID of the resource.

idrequired
string

The ID of the resource.

​
Query Parameters

order-by
string

Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=vendor:asc,created_at:desc

offset
Default: 0
integernull

Can be used for paginating results

limit
Default: 100
integernull

A number between 1 and 250 to determine the number of results to return in a single query

​
Response

metarequired
object
resultsrequired
object