Get all units

GEThttps://api.propexo.com/v1/units/

Authentication

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

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

x_id string

The external unit id

x_property_id string

Deprecated: Use the Propexo property_id instead

location_id string

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_id string

The Propexo property id

integration_id string

The Propexo integration id

integration_vendor string

Show 13 enum values

APPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST

The integration vendor for the unit.

unit_number string

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

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 object[]required
Array [
idstringrequired
The Propexo unique identifier for the unit
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
Method
propertyunits/getPropertyUnits
Example: unitX123
x_property_idstringrequired
The external ID of the property from the integration vendor
Method
propertyunits/getPropertyUnits
Example: property456
x_floor_plan_idstring | nullnullablerequired
The external ID of the floor plan from the integration vendor
Method
propertyunits/getPropertyUnits
Example: FP123
x_unit_type_idstring | nullnullablerequired
The external ID of the unit type from the integration vendor
Method
propertyunits/getPropertyUnits
Example: 12
bathroomsstring | nullnullablerequired
The number of bathrooms associated with the unit
Method
propertyunits/getPropertyUnits
Example: 2
bathrooms_fullnumber | nullnullablerequired
The number of full bathrooms associated with the unit
Method
propertyunits/getPropertyUnits
Example: 2
bathrooms_halfnumber | nullnullablerequired
The number of half bathrooms associated with the unit
Method
propertyunits/getPropertyUnits
bedroomsstring | nullnullablerequired
The number of bedrooms associated with the unit
Method
propertyunits/getPropertyUnits
Example: 3
building_namestring | nullnullablerequired
The building name associated with the unit
Method
propertyunits/getPropertyUnits
Example: Sunrise Apartments
building_numberstring | nullnullablerequired
The building number associated with the unit
Method
propertyunits/getPropertyUnits
Example: Bldg5
citystring | nullnullablerequired
The city associated with the unit
Method
propertyunits/getPropertyUnits
Example: Springfield
countrynullrequired
The country associated with the unit
Notice
This field will always be null for ENTRATA
Example: null
custom_data object | nullrequired
object
floor_plan_codestring | nullnullablerequireddeprecated
The external ID of the floor plan associated with the unit
Important
Deprecated in favor of floor_plan_id
Method
propertyunits/getPropertyUnits
Example: FP123
floor_plan_namestring | nullnullablerequireddeprecated
The floor plan name associated with the unit
Important
Deprecated in favor of floor_plan_id
Method
propertyunits/getPropertyUnits
Example: 3BHK Deluxe
floornullrequired
The floor number/name associated with the unit
Notice
This field will always be null for ENTRATA
Example: null
is_availableboolean | nullnullablerequired
Whether the unit is available
Method
propertyunits/getPropertyUnits
Example: true
is_furnishedboolean | nullnullablerequired
Whether the unit is furnished
Method
propertyunits/getPropertyUnits
Example: true
is_listednullrequireddeprecated
DEPRECATED: Use listings endpoints.
Notice
This field will always be null for ENTRATA
Example: null
is_vacantnullrequired
Whether the unit is vacant
Notice
This field will always be null for ENTRATA
Example: null
numberstring | nullnullablerequired
The unit number
Method
propertyunits/getPropertyUnits
Example: A202
rent_amount_market_in_centsnullrequired
The market rent amount in cents for the unit
Notice
This field will always be null for ENTRATA
Example: null
rent_amount_max_in_centsnumber | nullnullablerequired
The maximum rent amount in cents
Method
propertyunits/getPropertyUnits
Example: 200000
rent_amount_min_in_centsnumber | nullnullablerequired
The minimum rent amount in cents
Method
propertyunits/getPropertyUnits
Example: 180000
square_feetinteger | nullnullablerequired
The square footage of the unit
Method
propertyunits/getPropertyUnits
Possible values: >= 0
Example: 1200
statestring | nullnullablerequired
The state associated with the unit
Method
propertyunits/getPropertyUnits
Example: IL
street_address_1string | nullnullablerequireddeprecated
Deprecated: Use address_1
Method
propertyunits/getPropertyUnits
street_address_2nullrequireddeprecated
Deprecated: Use address_2
Notice
This field will always be null for ENTRATA
Example: null
address_1string | nullnullablerequired
The first address line associated with the unit
Method
propertyunits/getPropertyUnits
Example: 123 Main St
address_2string | nullnullablerequired
The second address line associated with the unit
Method
propertyunits/getPropertyUnits
Example: 123 Main St
zipstring | nullnullablerequired
The zip code associated with the unit
Method
propertyunits/getPropertyUnits
Example: 62704
pets_allowednullrequired
Whether or not pets are allowed
Notice
This field will always be null for ENTRATA
Example: null
dogs_allowednullrequired
Whether or not dogs are allowed
Notice
This field will always be null for ENTRATA
Example: null
cats_allowednullrequired
Whether or not cats are allowed
Notice
This field will always be null for ENTRATA
Example: null
pet_policynullrequired
The pet policy for the unit
Notice
This field will always be null for ENTRATA
Example: null
floor_plan_idstring | nullnullablerequired
The Propexo unique identifier for the floor plan
Method
propertyunits/getPropertyUnits
Example: cm7xvp5vb88803888363al35e7bse4z
integration_idstringrequired
The Propexo unique identifier for the integration
Example: clwh5u07w000508me66sfh3um
integration_vendorEnum15required
The property management system of record
Show 13 enum values
ENTRATAAPPFOLIOBUILDIUMMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST
Example: ENTRATA
property_idstringrequired
The Propexo unique identifier for the property
Example: clwi5xiix000008l6ctdgafyh
unit_type_idstring | nullnullablerequired
The Propexo unique identifier for the unit type
Method
propertyunits/getPropertyUnits
Example: cmpcsy72x000f04jrgtz847sq
]

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/units/

curl https://api.propexo.com/v1/units/ \
     -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": "unitX123",
      "x_property_id": "property456",
      "x_floor_plan_id": "FP123",
      "x_unit_type_id": "12",
      "bathrooms": "2",
      "bathrooms_full": 2,
      "bathrooms_half": 0,
      "bedrooms": "3",
      "building_name": "Sunrise Apartments",
      "building_number": "Bldg5",
      "city": "Springfield",
      "country": null,
      "custom_data": "Unknown Type: object,null",
      "floor": null,
      "is_available": true,
      "is_furnished": true,
      "is_vacant": null,
      "number": "A202",
      "rent_amount_market_in_cents": null,
      "rent_amount_max_in_cents": 200000,
      "rent_amount_min_in_cents": 180000,
      "square_feet": 1200,
      "state": "IL",
      "address_1": "123 Main St",
      "address_2": "123 Main St",
      "zip": "62704",
      "pets_allowed": null,
      "dogs_allowed": null,
      "cats_allowed": null,
      "pet_policy": null,
      "floor_plan_id": "cm7xvp5vb88803888363al35e7bse4z",
      "integration_id": "clwh5u07w000508me66sfh3um",
      "integration_vendor": "ENTRATA",
      "property_id": "clwi5xiix000008l6ctdgafyh",
      "unit_type_id": "cmpcsy72x000f04jrgtz847sq"
    }
  ]
}