Get a unit by ID

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

Authentication

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

Path parameters

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 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
Interface	Method
Common Data	GetUnitInformation
Example: 1234
x_property_idstringrequired
The external ID of the property from the integration vendor
Interface	Method
Common Data	GetUnitInformation
Example: oakridge
x_floor_plan_idnullrequired
The external ID of the floor plan from the integration vendor
Notice
This field will always be null for YARDI
Example: null
x_unit_type_idnullrequired
The external ID of the unit type from the integration vendor
Notice
This field will always be null for YARDI
Example: null
bathroomsstring | nullnullablerequired
The number of bathrooms associated with the unit
Interface	Method
Common Data	GetUnitInformation
Example: 1.5
bathrooms_fullnumber | nullnullablerequired
The number of full bathrooms associated with the unit
Interface	Method
Common Data	GetUnitInformation
Example: 1
bathrooms_halfnumber | nullnullablerequired
The number of half bathrooms associated with the unit
Interface	Method
Common Data	GetUnitInformation
Example: 1
bedroomsstring | nullnullablerequired
The number of bedrooms associated with the unit
Interface	Method
Common Data	GetUnitInformation
Example: 2
building_namestring | nullnullablerequired
The building name associated with the unit
Interface	Method
Common Data	GetUnitInformation
Example: Cedar Court
building_numberstring | nullnullablerequired
The building number associated with the unit
Interface	Method
Common Data	GetUnitInformation
Example: Cedar Court
citystring | nullnullablerequired
The city associated with the unit
Interface	Method
Common Data	GetUnitInformation
Example: Oakland
countrynullrequired
The country associated with the unit
Notice
This field will always be null for YARDI
Example: null
custom_data object | nullrequired
object
floor_plan_codestring | nullnullablerequired
The external ID of the floor plan associated with the unit
Interface	Method
Common Data	GetUnitInformation
Example: A2
floor_plan_namestring | nullnullablerequired
The floor plan name associated with the unit
Interface	Method
Common Data	GetUnitInformation
Example: Two Bedroom Deluxe
floornullrequired
The floor number/name associated with the unit
Notice
This field will always be null for YARDI
Example: null
is_availableboolean | nullnullablerequired
Whether the unit is available
Interface	Method
Common Data	GetUnitInformation
Example: true
is_furnishedboolean | nullnullablerequired
Whether the unit is furnished
Interface	Method
Common Data	GetUnitInformation
is_listednullrequireddeprecated
DEPRECATED: Use listings endpoints.
Notice
This field will always be null for YARDI
Example: null
is_vacantboolean | nullnullablerequired
Whether the unit is vacant
Interface	Method
Common Data	GetUnitInformation
numberstring | nullnullablerequired
The unit number
Interface	Method
Common Data	GetUnitInformation
Example: 20418
rent_amount_market_in_centsnumber | nullnullablerequired
The market rent amount in cents for the unit
Interface	Method
Common Data	GetUnitInformation
Example: 225000
rent_amount_max_in_centsnullrequired
The maximum rent amount in cents
Notice
This field will always be null for YARDI
Example: null
rent_amount_min_in_centsnullrequired
The minimum rent amount in cents
Notice
This field will always be null for YARDI
Example: null
square_feetinteger | nullnullablerequired
The square footage of the unit
Interface	Method
Common Data	GetUnitInformation
Possible values: >= 0
Example: 948
statestring | nullnullablerequired
The state associated with the unit
Interface	Method
Common Data	GetUnitInformation
Example: CA
street_address_1string | nullnullablerequireddeprecated
Deprecated: Use address_1
Interface	Method
Common Data	GetUnitInformation
street_address_2string | nullnullablerequireddeprecated
Deprecated: Use address_2
Interface	Method
Common Data	GetUnitInformation
address_1string | nullnullablerequired
The first address line associated with the unit
Interface	Method
Common Data	GetUnitInformation
Example: 1842 Cedar Avenue
address_2string | nullnullablerequired
The second address line associated with the unit
Interface	Method
Common Data	GetUnitInformation
Example: 1842 Cedar Avenue
zipstring | nullnullablerequired
The zip code associated with the unit
Interface	Method
Common Data	GetUnitInformation
Example: 94612
pets_allowednullrequired
Whether or not pets are allowed
Notice
This field will always be null for YARDI
Example: null
dogs_allowednullrequired
Whether or not dogs are allowed
Notice
This field will always be null for YARDI
Example: null
cats_allowednullrequired
Whether or not cats are allowed
Notice
This field will always be null for YARDI
Example: null
pet_policynullrequired
The pet policy for the unit
Notice
This field will always be null for YARDI
Example: null
floor_plan_idnullrequired
The Propexo unique identifier for the floor plan
Notice
This field will always be null for YARDI
Example: null
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
unit_type_idstring | nullnullablerequired
The Propexo unique identifier for the unit type
Interface	Method
Common Data	GetUnitInformation
Example: clwqjwc1e000008i7fnrrayzc:322_fs:UnitTypeUniqueID-2344

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/:id

curl https://api.propexo.com/v1/units/: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": "1234",
    "x_property_id": "oakridge",
    "x_floor_plan_id": null,
    "x_unit_type_id": null,
    "bathrooms": "1.5",
    "bathrooms_full": 1,
    "bathrooms_half": 1,
    "bedrooms": "2",
    "building_name": "Cedar Court",
    "building_number": "Cedar Court",
    "city": "Oakland",
    "country": null,
    "custom_data": "Unknown Type: object,null",
    "floor_plan_code": "A2",
    "floor_plan_name": "Two Bedroom Deluxe",
    "floor": null,
    "is_available": true,
    "is_furnished": true,
    "is_vacant": true,
    "number": "20418",
    "rent_amount_market_in_cents": 225000,
    "rent_amount_max_in_cents": null,
    "rent_amount_min_in_cents": null,
    "square_feet": 948,
    "state": "CA",
    "address_1": "1842 Cedar Avenue",
    "address_2": "1842 Cedar Avenue",
    "zip": "94612",
    "pets_allowed": null,
    "dogs_allowed": null,
    "cats_allowed": null,
    "pet_policy": null,
    "floor_plan_id": null,
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "YARDI",
    "property_id": "clwi5xiix000008l6ctdgafyh",
    "unit_type_id": "clwqjwc1e000008i7fnrrayzc:322_fs:UnitTypeUniqueID-2344"
  }
}