Residents

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.

get/v1/residents/

Request

Base URL: https://api.propexo.com
URL: https://api.propexo.com/v1/residents/
Auth: HTTP bearer

Query parameters

order-bystring

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 nullable

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

updated_at_ltestring nullable

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

last_seen_gtestring nullable

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 nullable

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

offsetinteger nullable

Can be used for paginating results

limitinteger nullable

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

x_idstring

The external resident id

x_property_idstring

Deprecated: Use Propexo property_id instead

location_idstring

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_idstring

The Propexo property id

lease_idstring

The Propexo lease id

integration_idstring

The Propexo integration id

The integration vendor for the resident.

email_1string

The primary email address associated with the resident

phone_1string

Filter by phone number (10 digit format only)

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.