{
  "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_resident_id": [
      "string",
      "null"
    ],
    "x_unit_id": [
      "string",
      "null"
    ],
    "residents_meta_data": [
      {
        "resident_id": "string",
        "x_resident_type": [
          "string",
          "null"
        ],
        "resident_type_normalized": "PRIMARY",
        "move_in_date": [
          "string",
          "null"
        ],
        "move_out_date": [
          "string",
          "null"
        ]
      }
    ],
    "application_date": [
      "string",
      "null"
    ],
    "custom_data": {},
    "deposit_amount": [
      "string",
      "null"
    ],
    "deposit_amount_in_cents": [
      "number",
      "null"
    ],
    "deposit_date": [
      "string",
      "null"
    ],
    "end_date": [
      "string",
      "null"
    ],
    "realized_move_in_date": [
      "string",
      "null"
    ],
    "realized_move_out_date": [
      "string",
      "null"
    ],
    "rent_amount_in_cents": [
      "number",
      "null"
    ],
    "rent_amount_market_in_cents": [
      "number",
      "null"
    ],
    "rent_due_day": [
      "integer",
      "null"
    ],
    "rent_due_date": [
      "string",
      "null"
    ],
    "scheduled_move_in_date": [
      "string",
      "null"
    ],
    "scheduled_move_out_date": [
      "string",
      "null"
    ],
    "signature_date": [
      "string",
      "null"
    ],
    "start_date": [
      "string",
      "null"
    ],
    "status": [
      "string",
      "null"
    ],
    "status_normalized": "ACTIVE",
    "status_raw": [
      "string",
      "null"
    ],
    "term": [
      "string",
      "null"
    ],
    "type": [
      "string",
      "null"
    ],
    "unit_id": [
      "string",
      "null"
    ],
    "property_id": "string",
    "integration_id": "string",
    "integration_vendor": "BUILDIUM"
  }
}

​
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