Get Lease Transfer by ID

GEThttps://api.propexo.com/v1/lease-transfers/:lease_transfer_id

Authentication

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

Path parameters

lease_transfer_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 lease transfer
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	GetUnitTransferData_DateRange
Example: 50
x_property_idstringrequired
The external ID of the property from the integration vendor
Interface	Method
Common Data	GetUnitTransferData_DateRange
Example: 50
x_location_idnullrequired
The external ID of the location (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations.
Notice
This field will always be null for YARDI
Example: null
x_resident_idstringrequired
The external ID of the resident from the integration vendor
Interface	Method
Common Data	GetUnitTransferData_DateRange
Example: 90
x_lease_id_nextstringrequired
The external ID of the next lease from the integration vendor
Interface	Method
Common Data	GetUnitTransferData_DateRange
Example: 50
x_lease_property_id_nextstring | nullnullablerequired
The external ID of the property associated with the next lease from the integration vendor
Interface	Method
Common Data	GetUnitTransferData_DateRange
Example: 50
x_lease_id_previousstringrequired
The external ID of the previous lease from the integration vendor
Interface	Method
Common Data	GetUnitTransferData_DateRange
Example: 49
x_lease_property_id_previousstring | nullnullablerequired
The external ID of the property associated with the previous lease from the integration vendor
Interface	Method
Common Data	GetUnitTransferData_DateRange
Example: 49
x_unit_id_nextstring | nullnullablerequired
The external ID of the next unit from the integration vendor
Interface	Method
Common Data	GetUnitTransferData_DateRange
Example: 113
x_unit_id_previousstring | nullnullablerequired
The external ID of the previous unit from the integration vendor
Interface	Method
Common Data	GetUnitTransferData_DateRange
Example: 112
resident_typestring | nullnullablerequired
The normalized type of the resident
Interface	Method
Common Data	GetUnitTransferData_DateRange
Example: PRIMARY
resident_type_rawstring | nullnullablerequired
The raw type of the resident
Interface	Method
Common Data	GetUnitTransferData_DateRange
Example: main
lease_status_nextstring | nullnullablerequired
The normalized status of the next lease
Interface	Method
Common Data	GetUnitTransferData_DateRange
Example: ACTIVE
lease_status_next_rawstring | nullnullablerequired
The raw status of the next lease
Interface	Method
Common Data	GetUnitTransferData_DateRange
Example: active
lease_status_previousstring | nullnullablerequired
The normalized status of the previous lease
Interface	Method
Common Data	GetUnitTransferData_DateRange
Example: ACTIVE
lease_status_previous_rawstring | nullnullablerequired
The raw status of the previous lease
Interface	Method
Common Data	GetUnitTransferData_DateRange
Example: active
transfer_effective_datestring | nullnullablerequired
The effective date of the lease transfer
Interface	Method
Common Data	GetUnitTransferData_DateRange
Example: 2024-07-01T00:00:00.000Z
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
resident_idstringrequired
The Propexo unique identifier for the resident
Interface	Method
Common Data	GetUnitTransferData_DateRange
Example: test_integration:12:90
lease_id_nextstringrequired
The Propexo unique identifier for the next lease
Interface	Method
Common Data	GetUnitTransferData_DateRange
Example: test_integration:12:50
lease_id_previousstringrequired
The Propexo unique identifier for the previous lease
Interface	Method
Common Data	GetUnitTransferData_DateRange
Example: test_integration:12:49
unit_id_nextstring | nullnullablerequired
The Propexo unique identifier for the next unit
Interface	Method
Common Data	GetUnitTransferData_DateRange
Example: test_integration:12:101
unit_id_previousstring | nullnullablerequired
The Propexo unique identifier for the previous unit
Interface	Method
Common Data	GetUnitTransferData_DateRange
Example: test_integration:12:100

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/lease-transfers/:lease_transfer_id

curl https://api.propexo.com/v1/lease-transfers/:lease_transfer_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": "50",
    "x_property_id": "50",
    "x_location_id": null,
    "x_resident_id": "90",
    "x_lease_id_next": "50",
    "x_lease_property_id_next": "50",
    "x_lease_id_previous": "49",
    "x_lease_property_id_previous": "49",
    "x_unit_id_next": "113",
    "x_unit_id_previous": "112",
    "resident_type": "PRIMARY",
    "resident_type_raw": "main",
    "lease_status_next": "ACTIVE",
    "lease_status_next_raw": "active",
    "lease_status_previous": "ACTIVE",
    "lease_status_previous_raw": "active",
    "transfer_effective_date": "2024-07-01T00:00:00.000Z",
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "YARDI",
    "property_id": "clwi5xiix000008l6ctdgafyh",
    "resident_id": "test_integration:12:90",
    "lease_id_next": "test_integration:12:50",
    "lease_id_previous": "test_integration:12:49",
    "unit_id_next": "test_integration:12:101",
    "unit_id_previous": "test_integration:12:100"
  }
}