API ReferenceLeases

Get all leases

Get all leases

Headers

AuthorizationstringRequired

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

Query parameters

order-bystringOptional

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

offsetintegerOptional
Can be used for paginating results
limitintegerOptional
A number between 1 and 250 to determine the number of results to return in a single query
x_idstringOptional
The external lease id
x_property_idstringOptional

Deprecated: Use the Propexo property_id instead

x_unit_idstringOptional

Deprecated: Use the Propexo unit_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.

unit_idstringOptional
The Propexo unique identifier for the unit
resident_idstringOptional

The Propexo unique identifier for the resident. If you use this filter in conjunction with one of the move-in/move-out date filters, it will not be honored and will be overridden by the date filter.

property_idstringOptional
The Propexo unique identifier for the property
integration_idstringOptional
The Propexo unique identifier for the integration
before_move_in_datestringOptional

Filter to residents moving in before this date. Format: YYYY-MM-DD. Date filter combinations will act with AND logic on a single record.

after_move_in_datestringOptional

Filter to residents moving in after this date. Format: YYYY-MM-DD. Date filter combinations will act with AND logic on a single record.

before_move_out_datestringOptional

Filter to residents moving out before this date. Format: YYYY-MM-DD. Date filter combinations will act with AND logic on a single record.

after_move_out_datestringOptional

Filter to residents moving out after this date. Format: YYYY-MM-DD. Date filter combinations will act with AND logic on a single record.

integration_vendorenumOptional
The integration vendor associated with the data diff
status_normalizedenumOptional
The normalized status for the lease
Allowed values:
status_rawstringOptional
The raw status associated with the lease
unit_numberstringOptional

The unit number of the lease. When using this, the Propexo property_id filter must be added as well.

Response

Successful response
metaobject
resultslist of objects

Errors