Get a resident by ID

GEThttps://api.propexo.com/v1/residents/:id

Authentication

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

Path parameters

id stringrequired

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=updated_at:desc

Default value: created_at:desc

updated_at_gte string | null

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

updated_at_lte string | null

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

last_seen_gte string | null

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_lte string | null

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

offset integer | null

Possible values: >= 0

Can be used for paginating results

Default value: 0

limit integer | null

Possible values: >= 0 and <= 250

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

Default value: 100

Response

Successful response

meta objectrequired
offsetinteger
The offset of the first result
Possible values: >= 0
Example: 0
limitinteger
The number of results to return
Possible values: >= 0 and <= 250
Example: 100
orderBy object[]required
The order of the results
Array [
object
]
hasMoreboolean | nullnullable
Whether there are more results
totalinteger
The total number of results
Possible values: >= 0
Example: 1000
results objectrequired
idstringrequired
The Propexo unique identifier for the resident
Example: clwktsp9v000008l31iv218hn
created_atstringrequired
The date record first entered Propexo
Example: 2024-03-21T15:38:08.337Z
updated_atstringrequired
The date record was last updated in Propexo
Example: 2024-03-22T10:59:45.119Z
last_seenstring | nullnullablerequired
The date the record was last seen from the PMS
Example: 2024-03-22T10:59:45.119Z
x_idstringrequired
The external ID from the integration vendor
Interface	Method
Rental Tenants	GET /leases/tenants
Example: 309864
x_lease_idnullrequireddeprecated
Deprecated. Use leases_meta_data instead
Notice
This field will always be null for BUILDIUM
Example: null
leases_meta_data object[]
Known associated lease meta data
Array [
lease_idstringrequired
The Propexo unique identifier for the lease
Interface	Method
Rental Tenants	GET /leases/tenants
Example: cmh2auz1v8837988519oz3dnopt4k07
x_resident_typestring | nullnullablerequired
The external type of the resident from the integration vendor
Interface	Method
Rental Tenants	GET /leases/tenants
Example: Tenant
resident_type_normalizedstring | nullnullablerequired
Resident type from Propexo
Interface	Method
Rental Tenants	GET /leases/tenants
Example: OTHER
Show 2 variants
• string
• stringPRIMARYSECONDARYGUARANTOROTHER
move_in_datestring | nullnullablerequired
The move-in date associated with the resident
Interface	Method
Rental Tenants	GET /leases/tenants
Example: 2024-02-01T00:00:00.000Z
move_out_datestring | nullnullablerequired
The move-out date associated with the resident
Interface	Method
Rental Tenants	GET /leases/tenants
Example: 2025-07-01T00:00:00.000Z
notice_datestring | nullnullablerequired
The date the resident gave notice
Interface	Method
Rental Tenants	GET /leases/tenants
Example: 2024-05-25T00:00:00.000Z
custom_data object | nullrequired
object
last_seenstring | nullnullablerequired
The date the record was last seen from the PMS
Example: 2024-03-22T10:59:45.119Z
]
address_1_alternatestring | nullnullablerequired
The first alternate address line associated with the resident
Interface	Method
Rental Tenants	GET /leases/tenants
Example: 123 Back Street
address_1string | nullnullablerequired
The first address line associated with the resident
Interface	Method
Rental Tenants	GET /leases/tenants
Example: 123 Round Street
address_2_alternatestring | nullnullablerequired
The second alternate address line associated with the resident
Interface	Method
Rental Tenants	GET /leases/tenants
Example: Apt 15
address_2string | nullnullablerequired
The second address line associated with the resident
Interface	Method
Rental Tenants	GET /leases/tenants
Example: Suite 825
balance_in_centsnumber | nullnullablerequired
The rent balance owed
Interface	Method
Rental Tenants	GET /leases/tenants
Example: 1000
city_alternatestring | nullnullablerequired
The alternate city associated with the resident
Interface	Method
Rental Tenants	GET /leases/tenants
Example: New York
citystring | nullnullablerequired
The city associated with the resident
Interface	Method
Rental Tenants	GET /leases/tenants
Example: Newark
country_alternatestring | nullnullablerequired
The alternate country associated with the resident
Interface	Method
Rental Tenants	GET /leases/tenants
Example: US
countrystring | nullnullablerequired
The country associated with the resident
Interface	Method
Rental Tenants	GET /leases/tenants
Example: US
custom_data object | nullrequired
object
date_of_birthstring | nullnullablerequired
The date of birth associated with the resident
Interface	Method
Rental Tenants	GET /leases/tenants
Example: 1981-01-01T00:00:00.000Z
email_1string | nullnullablerequired
The primary email address associated with the resident
Interface	Method
Rental Tenants	GET /leases/tenants
Example: [email protected]
email_2string | nullnullablerequired
The secondary email address associated with the resident
Interface	Method
Rental Tenants	GET /leases/tenants
Example: [email protected]
first_namestring | nullnullablerequired
The first name associated with the resident
Interface	Method
Rental Tenants	GET /leases/tenants
Example: John
is_employeenullrequired
Is the resident an employee
Notice
This field will always be null for BUILDIUM
Example: null
last_namestring | nullnullablerequired
The last name associated with the resident
Interface	Method
Rental Tenants	GET /leases/tenants
Example: Doe
late_balance_in_centsnumber | nullnullablerequired
The past due rent balance owed
Interface	Method
Rental Tenants	GET /leases/tenants
Example: 10000
middle_namenullrequired
The middle name associated with the resident
Notice
This field will always be null for BUILDIUM
Example: null
notesstring | nullnullablerequired
Notes associated with the resident
Interface	Method
Rental Tenants	GET /leases/tenants
Example: Friendly and playful
phone_1_typestring | nullnullablerequired
Type of the primary phone number
Interface	Method
Rental Tenants	GET /leases/tenants
Show 5 enum values
FAXHOMEMOBILEOTHERWORK
Example: MOBILE
phone_1string | nullnullablerequired
Primary phone number associated with the resident
Interface	Method
Rental Tenants	GET /leases/tenants
Example: (123) 456-7891
phone_2_typestring | nullnullablerequired
Type of the secondary phone number
Interface	Method
Rental Tenants	GET /leases/tenants
Show 5 enum values
FAXHOMEMOBILEOTHERWORK
Example: MOBILE
phone_2string | nullnullablerequired
Secondary phone number associated with the resident
Interface	Method
Rental Tenants	GET /leases/tenants
Example: (123) 456-7895
state_alternatestring | nullnullablerequired
The alternate state associated with the resident
Interface	Method
Rental Tenants	GET /leases/tenants
Example: MO
statestring | nullnullablerequired
The state associated with the resident
Interface	Method
Rental Tenants	GET /leases/tenants
Example: MO
zip_alternatestring | nullnullablerequired
The alternate zip code associated with the resident
Interface	Method
Rental Tenants	GET /leases/tenants
Example: 62705
zipstring | nullnullablerequired
The zip code associated with the resident
Interface	Method
Rental Tenants	GET /leases/tenants
Example: 62704
pets object[]required
Notice
This field is not currently hydrated for BUILDIUM
Array [
idstringrequired
The Propexo unique identifier for the resident pet
Example: clwktsp9v000008l31iv218hn
created_atstringrequired
The date record first entered Propexo
Example: 2024-03-21T15:38:08.337Z
updated_atstringrequired
The date record was last updated in Propexo
Example: 2024-03-22T10:59:45.119Z
last_seenstring | nullnullablerequired
The date the record was last seen from the PMS
Example: 2024-03-22T10:59:45.119Z
x_idstringrequired
The external ID from the integration vendor
namestring | nullnullablerequired
The name associated with the resident pet
Notice
This field is not currently hydrated for BUILDIUM
typestring | nullnullablerequired
The type associated with the resident pet
Notice
This field is not currently hydrated for BUILDIUM
breedstring | nullnullablerequired
The breed of the resident pet
Notice
This field is not currently hydrated for BUILDIUM
gender_rawstring | nullnullablerequired
The raw value for the gender of the resident pet
Notice
This field is not currently hydrated for BUILDIUM
age_in_yearsnumber | nullnullablerequired
The age in years of the resident pet
Notice
This field is not currently hydrated for BUILDIUM
weight_in_poundsnumber | nullnullablerequired
The weight in pounds of the resident pet
Notice
This field is not currently hydrated for BUILDIUM
is_fixedboolean | nullnullablerequired
Whether the resident pet is fixed
Notice
This field is not currently hydrated for BUILDIUM
is_service_animalboolean | nullnullablerequired
Whether the resident pet is a service animal
Notice
This field is not currently hydrated for BUILDIUM
notesstring | nullnullablerequired
Notes associated with the resident pet
Notice
This field is not currently hydrated for BUILDIUM
custom_data object | nullrequired
object
]
vehicles object[]required
Notice
This field is not currently hydrated for BUILDIUM
Array [
idstringrequired
The Propexo unique identifier for the resident vehicle
Example: clwktsp9v000008l31iv218hn
created_atstringrequired
The date record first entered Propexo
Example: 2024-03-21T15:38:08.337Z
updated_atstringrequired
The date record was last updated in Propexo
Example: 2024-03-22T10:59:45.119Z
last_seenstring | nullnullablerequired
The date the record was last seen from the PMS
Example: 2024-03-22T10:59:45.119Z
x_idstringrequired
The external ID from the integration vendor
makestring | nullnullablerequired
The make of the resident vehicle
Notice
This field is not currently hydrated for BUILDIUM
modelstring | nullnullablerequired
The Propexo data model (e.g. units, residents, applicants, etc.) associated with the resident vehicle
Notice
This field is not currently hydrated for BUILDIUM
colorstring | nullnullablerequired
The color of the resident vehicle
Notice
This field is not currently hydrated for BUILDIUM
yearstring | nullnullablerequired
The year of the resident vehicle
Notice
This field is not currently hydrated for BUILDIUM
license_plate_numberstring | nullnullablerequired
The license plate number of the resident vehicle
Notice
This field is not currently hydrated for BUILDIUM
license_plate_statestring | nullnullablerequired
The license plate state of the resident vehicle
Notice
This field is not currently hydrated for BUILDIUM
notesstring | nullnullablerequired
Notes associated with the resident vehicle
Notice
This field is not currently hydrated for BUILDIUM
custom_data object | nullrequired
object
]
integration_idstringrequired
The Propexo unique identifier for the integration
Example: clwh5u07w000508me66sfh3um
integration_vendorEnum14required
The property management system of record
Show 13 enum values
BUILDIUMAPPFOLIOENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST
Example: BUILDIUM
property_idstringrequired
The Propexo unique identifier for the property
Example: clwi5xiix000008l6ctdgafyh

Errors

• 400Bad Request

  error objectrequired
  codestringrequired
  Example: invalid_request
  messagestringrequired
  Example: invalid request
  details object
  property name*any
  Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}

GET /v1/residents/:id

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

200 Successful response

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "orderBy": [
      {}
    ],
    "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": "309864",
    "leases_meta_data": [
      {
        "lease_id": "cmh2auz1v8837988519oz3dnopt4k07",
        "x_resident_type": "Tenant",
        "resident_type_normalized": "OTHER",
        "move_in_date": "2024-02-01T00:00:00.000Z",
        "move_out_date": "2025-07-01T00:00:00.000Z",
        "notice_date": "2024-05-25T00:00:00.000Z",
        "custom_data": "Unknown Type: object,null",
        "last_seen": "2024-03-22T10:59:45.119Z"
      }
    ],
    "address_1_alternate": "123 Back Street",
    "address_1": "123 Round Street",
    "address_2_alternate": "Apt 15",
    "address_2": "Suite 825",
    "balance_in_cents": 1000,
    "city_alternate": "New York",
    "city": "Newark",
    "country_alternate": "US",
    "country": "US",
    "custom_data": "Unknown Type: object,null",
    "date_of_birth": "1981-01-01T00:00:00.000Z",
    "email_1": "[email protected]",
    "email_2": "[email protected]",
    "first_name": "John",
    "is_employee": null,
    "last_name": "Doe",
    "late_balance_in_cents": 10000,
    "middle_name": null,
    "notes": "Friendly and playful",
    "phone_1_type": "MOBILE",
    "phone_1": "(123) 456-7891",
    "phone_2_type": "MOBILE",
    "phone_2": "(123) 456-7895",
    "state_alternate": "MO",
    "state": "MO",
    "zip_alternate": "62705",
    "zip": "62704",
    "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": "string",
        "name": "string",
        "type": "string",
        "breed": "string",
        "gender_raw": "string",
        "age_in_years": 0,
        "weight_in_pounds": 0,
        "is_fixed": true,
        "is_service_animal": true,
        "notes": "string",
        "custom_data": "Unknown Type: object,null"
      }
    ],
    "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": "Unknown Type: object,null"
      }
    ],
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "BUILDIUM",
    "property_id": "clwi5xiix000008l6ctdgafyh"
  }
}