Get a unit detail by ID.

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

Note: "Unit Details" are not units themselves, but rather details regarding application/listing information on a unit. This is a separate concept from generic units data, and is required to be enabled as its own model. It is uncommon for customers to require this data. Please contact support with questions

Authentication

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

Path parameters

unit_detail_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
Prospect Management ODE	GetUnitsByProperty
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: 18

x_property_idstringrequired

The external ID of the property from the integration vendor

Interface	Method
Prospect Management ODE	GetUnitsByProperty
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: 5479123

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 REALPAGE

Example: null

x_building_idstring | nullnullablerequired

The external ID of the building (not necessarily the property) from the integration vendor

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: 2

x_floor_plan_idstring | nullnullablerequired

The external ID of the floor plan from the integration vendor

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: 1

building_numberstring | nullnullablerequired

The building number associated with the unit

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: 2

make_ready_datestring | nullnullablerequired

The make ready date of the unit

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty

Example: 2026-01-30T15:22:00.000Z

made_ready_datestring | nullnullablerequired

The made ready date of the unit

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: 2026-01-30T15:22:00.000Z

reserved_until_datestring | nullnullablerequired

The date the unit is reserved until

Interface	Method
Prospect Management ODE	GetUnitsByProperty
Pricing and Availability ODE	GetUnitsByProperty

Example: 2024-06-30T00:00:00.000Z

floor_plan_market_rent_in_centsnumber | nullnullablerequired

The market rent cost of the floor plan, in cents

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: 290300

unit_market_rent_in_centsnumber | nullnullablerequired

The market rent cost of the unit, in cents

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: 150000

base_rent_in_centsnumber | nullnullablerequired

The base rent cost of the unit, in cents

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: 303800

unit_numberstring | nullnullablerequired

The unit number

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: 158

descriptionstring | nullnullablerequired

Description of the unit

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: 2 bed 2 bath luxury unit

floor_plan_namestring | nullnullablerequired

The floor plan name associated with the unit

Interface	Method
Units ODE	List

Example: 2 bed 2 bath

accessible_hearingboolean | nullnullablerequired

Whether or not the unit is accessible for the hearing impaired

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: true

accessible_mobilityboolean | nullnullablerequired

Whether or not the unit is accessible for the mobility impaired

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: true

accessible_visionboolean | nullnullablerequired

Whether or not the unit is accessible for the vision impaired

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: true

is_vacantboolean | nullnullablerequired

Whether the unit is vacant

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: true

is_availableboolean | nullnullablerequired

Whether the unit is available

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: true

is_reservedboolean | nullnullablerequired

Whether the unit is reserved

Interface	Method
Prospect Management ODE	GetUnitsByProperty
Pricing and Availability ODE	GetUnitsByProperty

available_datestring | nullnullablerequired

The date that the unit becomes available

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: 2026-03-04T00:00:00.000Z

notesstring | nullnullablerequired

Notes associated with the unit

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: One of the greatest units we've ever seen

gross_square_feetintegerrequired

The gross square footage of the unit

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Possible values: >= 0

Example: 689

rentable_square_feetintegerrequired

The rentable square footage of the unit

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Possible values: >= 0

Example: 689

citystring | nullnullablerequired

The city associated with the unit

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: Milpitas

countrystring | nullnullablerequired

The country associated with the unit

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: US

statestring | nullnullablerequired

The state associated with the unit

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: CA

address_1string | nullnullablerequired

The first address line associated with the unit

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: 501 Murphy Ranch Rd Apt 158

address_2string | nullnullablerequired

The second address line associated with the unit

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: Apt 4

zipstring | nullnullablerequired

The zip code associated with the unit

Interface	Method
Pricing and Availability ODE	GetUnitsByProperty
Units ODE	List

Example: 95035-7937

maximum_potential_lease_termstring | nullnullablerequired

The maximum potential lease term of the unit

Interface	Method
Units ODE	List

Example: 14

minimum_potential_lease_termstring | nullnullablerequired

The minimum potential lease term of the unit

Interface	Method
Units ODE	List

Example: 6

integration_idstringrequired

The Propexo unique identifier for the integration

Example: clwh5u07w000508me66sfh3um

integration_vendorEnum19required

The property management system of record

Show 13 enum values

REALPAGEAPPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST

Example: REALPAGE

property_idstringrequired

The Propexo unique identifier for the property

Example: clwi5xiix000008l6ctdgafyh

Errors

400Bad Request

GET /v1/units/details/:unit_detail_id
curl https://api.propexo.com/v1/units/details/:unit_detail_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": "18",
    "x_property_id": "5479123",
    "x_location_id": null,
    "x_building_id": "2",
    "x_floor_plan_id": "1",
    "building_number": "2",
    "make_ready_date": "2026-01-30T15:22:00.000Z",
    "made_ready_date": "2026-01-30T15:22:00.000Z",
    "reserved_until_date": "2024-06-30T00:00:00.000Z",
    "floor_plan_market_rent_in_cents": 290300,
    "unit_market_rent_in_cents": 150000,
    "base_rent_in_cents": 303800,
    "unit_number": "158",
    "description": "2 bed 2 bath luxury unit",
    "floor_plan_name": "2 bed 2 bath",
    "accessible_hearing": true,
    "accessible_mobility": true,
    "accessible_vision": true,
    "is_vacant": true,
    "is_available": true,
    "is_reserved": true,
    "available_date": "2026-03-04T00:00:00.000Z",
    "notes": "One of the greatest units we've ever seen",
    "gross_square_feet": 689,
    "rentable_square_feet": 689,
    "city": "Milpitas",
    "country": "US",
    "state": "CA",
    "address_1": "501 Murphy Ranch Rd Apt 158",
    "address_2": "Apt 4",
    "zip": "95035-7937",
    "maximum_potential_lease_term": "14",
    "minimum_potential_lease_term": "6",
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "REALPAGE",
    "property_id": "clwi5xiix000008l6ctdgafyh"
  }
}

Get a unit detail by ID.

Authentication​

Path parameters​

Query parameters​

Response​

Errors​

Authentication

Path parameters

Query parameters

Response

Errors