Get a lease by ID

GEThttps://api.propexo.com/v1/leases/:lease_id

Authentication

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

Path parameters

lease_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
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
created_atstringrequired
The date record first entered Propexo
updated_atstringrequired
The date record was last updated in Propexo
last_seenstring | nullnullablerequired
The date the record was last seen from the PMS
x_idstringrequired
The external ID from the integration vendor
x_property_idstringrequired
The external ID of the property from the integration vendor
x_resident_idstring | nullnullablerequireddeprecated
Deprecated. Use residents_meta_data instead
x_unit_idstring | nullnullablerequired
The external ID of the unit from the integration vendor
residents_meta_data object[]
Array [
resident_idstringrequired
The Propexo unique identifier for the resident
x_resident_typestring | nullnullablerequired
The external type of the resident from the integration vendor
resident_type_normalizedstring | nullnullablerequired
Resident type from Propexo
Show 2 variants
• string
• stringPRIMARYSECONDARYGUARANTOROTHER
move_in_datestring | nullnullablerequired
The move-in date associated with the resident
Example: 2024-01-01T00:00:00.000Z
move_out_datestring | nullnullablerequired
The move-out date associated with the resident
notice_datestring | nullnullablerequired
The date the resident gave notice
custom_data object | nullrequired
object
last_seenstring | nullnullablerequired
The date the record was last seen from the PMS
]
application_datestring | nullnullablerequired
The application date associated with the lease
custom_data object | nullrequired
object
deposit_amountstring | nullnullablerequired
The deposit amount associated with the lease
deposit_amount_in_centsnumber | nullnullablerequired
The deposit amount in cents associated with the lease
Example: 100000
deposit_datestring | nullnullablerequired
The deposit date associated with the lease
end_datestring | nullnullablerequired
The end date associated with the lease
realized_move_in_datestring | nullnullablerequireddeprecated
DEPRECATED: Please use residents_meta_data to view resident move in dates
realized_move_out_datestring | nullnullablerequireddeprecated
DEPRECATED: Please use residents_meta_data to view resident move out dates
rent_amount_in_centsnumber | nullnullablerequired
The rent amount in cents for the lease
Example: 100000
rent_amount_market_in_centsnumber | nullnullablerequired
The market rent amount in cents for the lease
Example: 100000
rent_due_dayinteger | nullnullablerequired
The rent due day associated with the lease
Possible values: >= 0
rent_due_datestring | nullnullablerequired
The rent due date associated with the lease
scheduled_move_in_datestring | nullnullablerequireddeprecated
DEPRECATED: Please use residents_meta_data to view resident move in dates
scheduled_move_out_datestring | nullnullablerequireddeprecated
DEPRECATED: Please use residents_meta_data to view resident move out dates
signature_datestring | nullnullablerequired
The date the lease was signed
start_datestring | nullnullablerequired
The start date associated with the lease
statusstring | nullnullablerequireddeprecated
DEPRECATED. Use status_normalized
status_normalizedstring | nullnullablerequired
The normalized status for the lease. Note that the status may be called "EVICTED" but this can also refer to an active resident undergoing a current eviction. This varies per PMS.
Show 5 enum values
ACTIVEINACTIVEOTHERPENDINGEVICTED
status_rawstring | nullnullablerequired
The raw status associated with the lease
termstring | nullnullablerequired
The lease term
typestring | nullnullablerequired
The type of lease
unit_numberstring | nullnullablerequired
The unit number associated with the lease. This isn't always provided by PMS vendors, but may be the only data provided to identify a unit associated with a service request in some cases.
write_off_amount_in_centsnumber | nullnullablerequired
The write off amount for the lease, in cents
Example: 100000
write_off_amount_rawstring | nullnullablerequired
The raw write off amount of the lease from the PMS
balance_amount_in_centsnumber | nullnullablerequired
The balance amount for the lease, in cents
Example: 100000
balance_amount_rawstring | nullnullablerequired
The raw balance amount of the lease from the PMS
past_due_balance_in_centsnumber | nullnullablerequired
The past due balance for the lease, in cents
Example: 100000
past_due_balance_rawstring | nullnullablerequired
The raw past due balance of the lease from the PMS
unit_idstring | nullnullablerequired
The Propexo unique identifier for the unit
property_idstringrequired
The Propexo unique identifier for the property
integration_idstringrequired
The Propexo unique identifier for the integration
integration_vendorEnum1required
The property management system of record
Show 13 enum values
APPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST
services object[]required
Array [
idstringrequired
The Propexo unique identifier for the lease service
created_atstringrequired
The date record first entered Propexo
updated_atstringrequired
The date record was last updated in Propexo
last_seenstringrequired
The date the record was last seen from the PMS
namestringrequired
The name of the lease service
lease_idstringrequired
The Propexo unique identifier for the lease
]

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/leases/:lease_id

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

200 Successful response

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "orderBy": [
      {}
    ],
    "hasMore": true,
    "total": 1000
  },
  "results": {
    "id": "string",
    "created_at": "string",
    "updated_at": "string",
    "last_seen": "string",
    "x_id": "string",
    "x_property_id": "string",
    "x_unit_id": "string",
    "residents_meta_data": [
      {
        "resident_id": "string",
        "x_resident_type": "string",
        "resident_type_normalized": "string",
        "move_in_date": "2024-01-01T00:00:00.000Z",
        "move_out_date": "string",
        "notice_date": "string",
        "custom_data": "Unknown Type: object,null",
        "last_seen": "string"
      }
    ],
    "application_date": "string",
    "custom_data": "Unknown Type: object,null",
    "deposit_amount": "string",
    "deposit_amount_in_cents": 100000,
    "deposit_date": "string",
    "end_date": "string",
    "rent_amount_in_cents": 100000,
    "rent_amount_market_in_cents": 100000,
    "rent_due_day": 0,
    "rent_due_date": "string",
    "signature_date": "string",
    "start_date": "string",
    "status_normalized": "ACTIVE",
    "status_raw": "string",
    "term": "string",
    "type": "string",
    "unit_number": "string",
    "write_off_amount_in_cents": 100000,
    "write_off_amount_raw": "string",
    "balance_amount_in_cents": 100000,
    "balance_amount_raw": "string",
    "past_due_balance_in_cents": 100000,
    "past_due_balance_raw": "string",
    "unit_id": "string",
    "property_id": "string",
    "integration_id": "string",
    "integration_vendor": "APPFOLIO",
    "services": [
      {
        "id": "string",
        "created_at": "string",
        "updated_at": "string",
        "last_seen": "string",
        "name": "string",
        "lease_id": "string"
      }
    ]
  }
}