{
  "meta": {
    "offset": "integer",
    "limit": "integer",
    "orderBy": [
      {}
    ],
    "hasMore": [
      "boolean",
      "null"
    ],
    "total": "number"
  },
  "results": [
    {
      "id": "string",
      "created_at": "string",
      "updated_at": "string",
      "x_id": "string",
      "x_lease_id": [
        "string",
        "null"
      ],
      "leases_meta_data": [
        {
          "lease_id": "string",
          "x_resident_type": [
            "string",
            "null"
          ],
          "resident_type_normalized": "PRIMARY"
        }
      ],
      "address_1_alternate": [
        "string",
        "null"
      ],
      "address_1": [
        "string",
        "null"
      ],
      "address_2_alternate": [
        "string",
        "null"
      ],
      "address_2": [
        "string",
        "null"
      ],
      "balance_in_cents": [
        "number",
        "null"
      ],
      "city_alternate": [
        "string",
        "null"
      ],
      "city": [
        "string",
        "null"
      ],
      "country_alternate": [
        "string",
        "null"
      ],
      "country": [
        "string",
        "null"
      ],
      "custom_data": {},
      "date_of_birth": [
        "string",
        "null"
      ],
      "email_1": [
        "string",
        "null"
      ],
      "email_2": [
        "string",
        "null"
      ],
      "first_name": [
        "string",
        "null"
      ],
      "is_employee": [
        "boolean",
        "null"
      ],
      "last_name": [
        "string",
        "null"
      ],
      "late_balance_in_cents": [
        "number",
        "null"
      ],
      "middle_name": [
        "string",
        "null"
      ],
      "notes": [
        "string",
        "null"
      ],
      "phone_1_type": "FAX",
      "phone_1": [
        "string",
        "null"
      ],
      "phone_2_type": "FAX",
      "phone_2": [
        "string",
        "null"
      ],
      "state_alternate": [
        "string",
        "null"
      ],
      "state": [
        "string",
        "null"
      ],
      "zip_alternate": [
        "string",
        "null"
      ],
      "zip": [
        "string",
        "null"
      ],
      "integration_id": "string",
      "integration_vendor": "string",
      "property_id": "string"
    }
  ]
}

​
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

x_id
string

The external resident id

x_property_id
string

The external property id

property_id
string

The Propify property id

lease_id
string

The Propify lease id

integration_id
string

The Propify integration id

integration_vendor
string

The integration vendor for the resident.

​
Response

metarequired
object
resultsrequired
array