Get all residents

GET

/v1/residents/

GET

/v1/residents/

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": "t000123",
      "address_1_alternate": null,
      "address_1": "123 Sunset Blvd",
      "address_2_alternate": null,
      "address_2": "Suite 23",
      "balance_in_cents": null,
      "city_alternate": null,
      "city": "Los Angeles",
      "country_alternate": null,
      "country": "United States",
      "custom_data": {},
      "date_of_birth": "1992-04-18T00:00:00.000Z",
      "email_1": "maya.chen@example.com",
      "email_2": null,
      "first_name": "Maya",
      "is_employee": null,
      "last_name": "Chen",
      "late_balance_in_cents": null,
      "middle_name": null,
      "notes": null,
      "phone_1_type": "MOBILE",
      "phone_1": "4155550142",
      "phone_2_type": "HOME",
      "phone_2": "4155550198",
      "state_alternate": null,
      "state": "CA",
      "zip_alternate": null,
      "zip": "90069",
      "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": "cl8k2nqwe0019jsxq9ab1c2dw",
          "name": "Maple",
          "type": "Dog",
          "breed": "Labrador Retriever",
          "gender_raw": "Female",
          "age_in_years": 4,
          "weight_in_pounds": 62,
          "is_fixed": true,
          "is_service_animal": true,
          "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": "cl8k2nqwe0020jsxq9ab1c2dx",
          "make": "Honda",
          "model": "Civic",
          "color": "Blue",
          "year": "2019",
          "license_plate_number": "7KRM294",
          "license_plate_state": "CA",
          "notes": null,
          "custom_data": {}
        }
      ],
      "integration_id": "clwh5u07w000508me66sfh3um",
      "integration_vendor": "YARDI",
      "property_id": "clwi5xiix000008l6ctdgafyh",
      "x_lease_id": null,
      "leases_meta_data": [
        {
          "lease_id": "cm2dtyq1600008loze5xgf3fb",
          "x_resident_type": "Primary",
          "resident_type_normalized": "PRIMARY",
          "move_in_date": "2023-01-01T00:00:00.000Z",
          "move_out_date": "2024-01-01T00:00:00.000Z",
          "notice_date": "2023-09-01T00:00:00.000Z",
          "custom_data": {},
          "last_seen": "2024-03-22T10:59:45.119Z"
        }
      ]
    }
  ]
}

Get all residents

Starting March 30, 2026, syncing the residents model from Yardi will only return residents modified within the last 2 days. This change applies to new customers only - if you have already built against the Yardi Get Residents endpoint that Propexo offers, your integration will not be affected. If you are a new customer and sync the residents model less frequently than once every 2 days, please contact support to avoid gaps in your data.

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

updated_at_gtestring or nullOptional

Filter to records updated at or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)

updated_at_ltestring or nullOptional

Filter to records updated at or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)

last_seen_gtestring or nullOptional

Filter to records whose last_seen date is on or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)

last_seen_ltestring or nullOptional

Filter to records whose last_seen date is on or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)

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