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
Common Data	GetCurrentUnitInformation
Common Data	GetResidents
Common Data	GetResidentsByDate
Common Data	GetResidentsByStatus
ILS Guest Card	GetApplication_Login
Common Data	GetResidentData

Example: t000123

x_lease_idnullrequireddeprecated

Deprecated. Use leases_meta_data instead

Notice

This field will always be null for YARDI

Example: null

leases_meta_data object[]

Known associated lease meta data

Array [

lease_idstringrequired

The Propexo unique identifier for the lease

Interface	Method
Common Data	GetResidents
Common Data	GetResidentsByDate
Common Data	GetResidentsByStatus

Example: cm2dtyq1600008loze5xgf3fb

x_resident_typestring | nullnullablerequired

The external type of the resident from the integration vendor

Interface	Method
Common Data	GetResidents
Common Data	GetResidentsByDate
Common Data	GetResidentsByStatus

Example: Primary

resident_type_normalizedstring | nullnullablerequired

Resident type from Propexo

Interface	Method
Common Data	GetResidents
Common Data	GetResidentsByDate
Common Data	GetResidentsByStatus

Example: PRIMARY

Show 2 variants

string
stringPRIMARYSECONDARYGUARANTOROTHER

move_in_datestring | nullnullablerequired

The move-in date associated with the resident

Interface	Method
Common Data	GetResidents
Common Data	GetResidentsByDate
Common Data	GetResidentsByStatus

Example: 2023-01-01T00:00:00.000Z

move_out_datestring | nullnullablerequired

The move-out date associated with the resident

Interface	Method
Common Data	GetResidents
Common Data	GetResidentsByDate
Common Data	GetResidentsByStatus

Example: 2024-01-01T00:00:00.000Z

notice_datestring | nullnullablerequired

The date the resident gave notice

Interface	Method
Common Data	GetResidents
Common Data	GetResidentsByDate
Common Data	GetResidentsByStatus

Example: 2023-09-01T00: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_alternatenullrequired

The first alternate address line associated with the resident

Notice

This field will always be null for YARDI

Example: null

address_1string | nullnullablerequired

The first address line associated with the resident

Important

Hydrating this field requires making requests to an additional API which will increase your processed records count. Please contact support to enable. Hydrating address fields will require making requests to an additional API which will increase your processed records count. Please contact support to enable.

Interface	Method
Common Data	GetCurrentUnitInformation
Common Data	GetResidentData

Example: 123 Sunset Blvd

address_2_alternatenullrequired

The second alternate address line associated with the resident

Notice

This field will always be null for YARDI

Example: null

address_2string | nullnullablerequired

The second address line associated with the resident

Important

Hydrating this field requires making requests to an additional API which will increase your processed records count. Please contact support to enable.

Interface	Method
Common Data	GetCurrentUnitInformation
Common Data	GetResidentData

Example: Suite 23

balance_in_centsnullrequired

The rent balance owed

Notice

This field will always be null for YARDI

Example: null

city_alternatenullrequired

The alternate city associated with the resident

Notice

This field will always be null for YARDI

Example: null

citystring | nullnullablerequired

The city associated with the resident

Important

Hydrating this field requires making requests to an additional API which will increase your processed records count. Please contact support to enable.

Interface	Method
Common Data	GetCurrentUnitInformation
Common Data	GetResidentData

Example: Los Angeles

country_alternatenullrequired

The alternate country associated with the resident

Notice

This field will always be null for YARDI

Example: null

countrystring | nullnullablerequired

The country associated with the resident

Important

Hydrating this field requires making requests to an additional API which will increase your processed records count. Please contact support to enable.

Interface	Method
Common Data	GetCurrentUnitInformation
Common Data	GetResidentData

Example: United States

custom_data object | nullrequired

object

date_of_birthstring | nullnullablerequired

The date of birth associated with the resident

Important

Hydrating this field requires making requests to an additional API which will increase your processed records count. Please contact support to enable.

Interface	Method
ILS Guest Card	GetApplication_Login

Example: 1992-04-18T00:00:00.000Z

email_1string | nullnullablerequired

The primary email address associated with the resident

Interface	Method
Common Data	GetResidents
Common Data	GetResidentsByDate
Common Data	GetResidentsByStatus

Example: [email protected]

email_2nullrequired

The secondary email address associated with the resident

Notice

This field will always be null for YARDI

Example: null

first_namestring | nullnullablerequired

The first name associated with the resident

Interface	Method
Common Data	GetResidents
Common Data	GetResidentsByDate
Common Data	GetResidentsByStatus

Example: Maya

is_employeenullrequired

Is the resident an employee

Notice

This field will always be null for YARDI

Example: null

last_namestring | nullnullablerequired

The last name associated with the resident

Interface	Method
Common Data	GetResidents
Common Data	GetResidentsByDate
Common Data	GetResidentsByStatus

Example: Chen

late_balance_in_centsnullrequired

The past due rent balance owed

Notice

This field will always be null for YARDI

Example: null

middle_namenullrequired

The middle name associated with the resident

Notice

This field will always be null for YARDI

Example: null

notesnullrequired

Notes associated with the resident

Notice

This field will always be null for YARDI

Example: null

phone_1_typestring | nullnullablerequired

Type of the primary phone number

Interface	Method
Common Data	GetResidentsByStatus
Common Data	GetResidentData

Show 5 enum values

FAXHOMEMOBILEOTHERWORK

Example: MOBILE

phone_1string | nullnullablerequired

Primary phone number associated with the resident

Important

Hydrating phone fields will require making requests to an additional API which will increase your processed records count. Please contact support to enable.

Interface	Method
Common Data	GetResidentsByStatus
Common Data	GetResidentData

Example: 4155550142

phone_2_typestring | nullnullablerequired

Type of the secondary phone number

Interface	Method
Common Data	GetResidentData

Show 5 enum values

FAXHOMEMOBILEOTHERWORK

Example: HOME

phone_2string | nullnullablerequired

Secondary phone number associated with the resident

Interface	Method
Common Data	GetResidentData

Example: 4155550198

state_alternatenullrequired

The alternate state associated with the resident

Notice

This field will always be null for YARDI

Example: null

statestring | nullnullablerequired

The state associated with the resident

Important

Hydrating this field requires making requests to an additional API which will increase your processed records count. Please contact support to enable.

Interface	Method
Common Data	GetCurrentUnitInformation
Common Data	GetResidentData

Example: CA

zip_alternatenullrequired

The alternate zip code associated with the resident

Notice

This field will always be null for YARDI

Example: null

zipstring | nullnullablerequired

The zip code associated with the resident

Important

Hydrating this field requires making requests to an additional API which will increase your processed records count. Please contact support to enable.

Interface	Method
Common Data	GetCurrentUnitInformation
Common Data	GetResidentData

Example: 90069

pets object[]required

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

Important

Pet data in Yardi requires additional configuration for your Propexo integration. Please contact Propexo support for more information.

Interface	Method
Common Data	GetResidentData

Example: cl8k2nqwe0019jsxq9ab1c2dw

namestring | nullnullablerequired

The name associated with the resident pet

Interface	Method
Common Data	GetResidentData

Example: Maple

typestring | nullnullablerequired

The type associated with the resident pet

Interface	Method
Common Data	GetResidentData

Example: Dog

breedstring | nullnullablerequired

The breed of the resident pet

Interface	Method
Common Data	GetResidentData

Example: Labrador Retriever

gender_rawstring | nullnullablerequired

The raw value for the gender of the resident pet

Interface	Method
Common Data	GetResidentData

Example: Female

age_in_yearsnumber | nullnullablerequired

The age in years of the resident pet

Interface	Method
Common Data	GetResidentData

Example: 4

weight_in_poundsnumber | nullnullablerequired

The weight in pounds of the resident pet

Interface	Method
Common Data	GetResidentData

Example: 62

is_fixedboolean | nullnullablerequired

Whether the resident pet is fixed

Interface	Method
Common Data	GetResidentData

Example: true

is_service_animalboolean | nullnullablerequired

Whether the resident pet is a service animal

Interface	Method
Common Data	GetResidentData

notesnullrequired

Notes associated with the resident pet

Notice

This field will always be null for YARDI

Example: null

custom_data object | nullrequired

object

]

vehicles object[]required

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

Important

Vehicle data in Yardi requires additional configuration for your Propexo integration. Please contact Propexo support for more information.

Interface	Method
Common Data	GetResidentData

Example: cl8k2nqwe0020jsxq9ab1c2dx

makestring | nullnullablerequired

The make of the resident vehicle

Interface	Method
Common Data	GetResidentData

Example: Honda

modelstring | nullnullablerequired

The Propexo data model (e.g. units, residents, applicants, etc.) associated with the resident vehicle

Interface	Method
Common Data	GetResidentData

Example: Civic

colorstring | nullnullablerequired

The color of the resident vehicle

Interface	Method
Common Data	GetResidentData

Example: Blue

yearstring | nullnullablerequired

The year of the resident vehicle

Interface	Method
Common Data	GetResidentData

Example: 2019

license_plate_numberstring | nullnullablerequired

The license plate number of the resident vehicle

Interface	Method
Common Data	GetResidentData

Example: 7KRM294

license_plate_statestring | nullnullablerequired

The license plate state of the resident vehicle

Interface	Method
Common Data	GetResidentData

Example: CA

notesnullrequired

Notes associated with the resident vehicle

Notice

This field will always be null for YARDI

Example: null

custom_data object | nullrequired

object

]

integration_idstringrequired

The Propexo unique identifier for the integration

Example: clwh5u07w000508me66sfh3um

integration_vendorEnum24required

The property management system of record

Show 13 enum values

YARDIAPPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDI_REST

Example: YARDI

property_idstringrequired

The Propexo unique identifier for the property

Example: clwi5xiix000008l6ctdgafyh

Errors

400Bad Request

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": "t000123",
    "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": "Unknown Type: object,null",
        "last_seen": "2024-03-22T10:59:45.119Z"
      }
    ],
    "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": "Unknown Type: object,null",
    "date_of_birth": "1992-04-18T00:00:00.000Z",
    "email_1": "[email protected]",
    "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": "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": "cl8k2nqwe0020jsxq9ab1c2dx",
        "make": "Honda",
        "model": "Civic",
        "color": "Blue",
        "year": "2019",
        "license_plate_number": "7KRM294",
        "license_plate_state": "CA",
        "notes": null,
        "custom_data": "Unknown Type: object,null"
      }
    ],
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "YARDI",
    "property_id": "clwi5xiix000008l6ctdgafyh"
  }
}

Get a resident by ID

Authentication​

Path parameters​

Query parameters​

Response​

Errors​

Authentication

Path parameters

Query parameters

Response

Errors