Get all residents | Propexo

curl https://api.propexo.com/v1/residents/ \
     -H "Authorization: Bearer <token>"

{
  "meta": {
    "orderBy": [
      {}
    ],
    "offset": 0,
    "limit": 100,
    "hasMore": true,
    "total": 1000
  },
  "results": [
    {
      "id": "clwktsp9v000008l31iv218hn",
      "created_at": "2024-03-21T15:38:08.337Z",
      "updated_at": "2024-03-22T10:59:45.119Z",
      "last_seen": "2024-03-22T10:59:45.119Z",
      "x_id": "00000123",
      "address_1_alternate": null,
      "address_1": null,
      "address_2_alternate": null,
      "address_2": null,
      "balance_in_cents": null,
      "city_alternate": null,
      "city": null,
      "country_alternate": null,
      "country": null,
      "custom_data": {},
      "date_of_birth": null,
      "email_1": "jane.doe@example.com",
      "email_2": null,
      "first_name": "Jane",
      "is_employee": null,
      "last_name": "Doe",
      "late_balance_in_cents": null,
      "middle_name": null,
      "notes": null,
      "phone_1_type": "MOBILE",
      "phone_1": "5555555555",
      "phone_2_type": "OTHER",
      "phone_2": "5555555554",
      "state_alternate": null,
      "state": null,
      "zip_alternate": null,
      "zip": null,
      "pets": [
        {
          "id": "clwktsp9v000008l31iv218hn",
          "created_at": "2024-03-21T15:38:08.337Z",
          "updated_at": "2024-03-22T10:59:45.119Z",
          "last_seen": "2024-03-22T10:59:45.119Z",
          "x_id": "89",
          "name": null,
          "type": "D",
          "breed": null,
          "gender_raw": null,
          "age_in_years": null,
          "weight_in_pounds": null,
          "is_fixed": null,
          "is_service_animal": null,
          "notes": null,
          "custom_data": {}
        }
      ],
      "vehicles": [
        {
          "id": "clwktsp9v000008l31iv218hn",
          "created_at": "2024-03-21T15:38:08.337Z",
          "updated_at": "2024-03-22T10:59:45.119Z",
          "last_seen": "2024-03-22T10:59:45.119Z",
          "x_id": "string",
          "make": "string",
          "model": "string",
          "color": "string",
          "year": "string",
          "license_plate_number": "string",
          "license_plate_state": "string",
          "notes": "string",
          "custom_data": {}
        }
      ],
      "integration_id": "clwh5u07w000508me66sfh3um",
      "integration_vendor": "MRI",
      "property_id": "clwi5xiix000008l6ctdgafyh",
      "x_lease_id": "string",
      "leases_meta_data": [
        {
          "lease_id": "cmbz5jylv9133791496c6cf2a8d7apq",
          "x_resident_type": "Other Resident",
          "resident_type_normalized": "OTHER",
          "move_in_date": null,
          "move_out_date": null,
          "notice_date": null,
          "custom_data": {},
          "last_seen": "2024-03-22T10:59:45.119Z"
        }
      ]
    }
  ]
}

Get all residents Only current and future residents will be synced by default. If you want past residents, please reach out to support for us to enable this.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

order-bystringOptionalDefaults to created_at:desc

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

offsetinteger or nullOptional>=0Defaults to 0

Can be used for paginating results

limitinteger or nullOptional0-250Defaults to 100

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

x_idstringOptional

The external resident id

x_property_idstringOptional

Deprecated: Use Propexo property_id instead

location_idstringOptional

The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations.

property_idstringOptional

The Propexo property id

lease_idstringOptional

The Propexo lease id

integration_idstringOptional

The Propexo integration id

integration_vendorenumOptional

The integration vendor for the resident.

email_1stringOptional

The primary email address associated with the resident

phone_1stringOptionalformat: "^[2-9]\d{9}$"

Filter by phone number (10 digit format only)

Response

Successful response

metaobject

resultslist of objects

Errors

400

Bad Request Error