Get a listing by ID

GEThttps://api.propexo.com/v1/listings/:listing_id

Authentication

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

Path parameters

listing_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 listing
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
getBuildings
Example: 902114
x_property_idstringrequired
The external ID of the property from the integration vendor
Method
getBuildings
Example: 481920
x_unit_idstring | nullnullablerequired
The external ID of the unit from the integration vendor
Method
getBuildings
Example: 902114
x_floor_plan_idnullrequired
The external ID of the floor plan from the integration vendor
Notice
This field will always be null for PROPERTYWARE
Example: null
is_unitbooleanrequired
True if the listing is for a unit, false if it is not associated with a specific unit
Method
getBuildings
Example: true
available_datestring | nullnullablerequired
The date the listing is available
Method
getBuildings
Example: 2025-04-01T00:00:00.000Z
application_urlstring | nullnullablerequired
The application URL for the listing
Method
getBuildings
Example: https://oakapartments.propertyware.com/forsale.html?uid=902114
bathroomsstring | nullnullablerequired
The number of bathrooms associated with the listing
Method
getBuildings
Example: 2.5
bathrooms_fullnumber | nullnullablerequired
The number of full bathrooms associated with the listing
Method
getBuildings
Example: 2
bathrooms_halfnumber | nullnullablerequired
The number of half bathrooms associated with the listing
Method
getBuildings
Example: 1
bedroomsstring | nullnullablerequired
The number of bedrooms associated with the listing
Method
getBuildings
Example: 2
building_namestring | nullnullablerequired
The building name associated with the listing
Method
getBuildings
Example: Oak Apartments
building_numbernullrequired
The building number associated with the listing
Notice
This field will always be null for PROPERTYWARE
Example: null
citystring | nullnullablerequired
The city associated with the listing
Method
getBuildings
Example: Austin
countrystring | nullnullablerequired
The country associated with the listing
Method
getBuildings
Example: USA
custom_data object | nullrequired
object
deposit_amount_in_centsnumber | nullnullablerequired
The deposit amount in cents associated with the listing
Method
getBuildings
Example: 150000
floor_plan_codenullrequired
The external ID of the floor plan associated with the listing
Notice
This field will always be null for PROPERTYWARE
Example: null
floor_plan_namenullrequired
The floor plan name associated with the listing
Notice
This field will always be null for PROPERTYWARE
Example: null
floorstring | nullnullablerequired
The floor number/name associated with the listing
Method
getBuildings
Example: 2
image_urlsnullrequired
A list of image urls associated with the listing
Notice
This field will always be null for PROPERTYWARE
Example: null
is_availableboolean | nullnullablerequired
Whether the listing is available
Method
getBuildings
Example: true
is_furnishednullrequired
Whether the listing is furnished
Notice
This field will always be null for PROPERTYWARE
Example: null
is_listedboolean | nullnullablerequired
Whether the listing is listed
Method
getBuildings
Example: true
is_managed_externalnullrequired
Whether the listing is managed externally
Notice
This field will always be null for PROPERTYWARE
Example: null
is_vacantboolean | nullnullablerequired
Whether the listing is vacant
Method
getBuildings
Example: true
lease_termstring | nullnullablerequired
The term of the lease
Method
getBuildings
Example: 12 Months
listing_titlestring | nullnullablerequired
The title used for the marketing listing
Method
getBuildings
Example: Spacious 2 Bedroom
listing_datenullrequired
The date the listing was created
Notice
This field will always be null for PROPERTYWARE
Example: null
marketing_namestring | nullnullablerequired
The marketing name of the unit being listed
Method
getBuildings
Example: Oak Apartments
notesstring | nullnullablerequired
Notes associated with the listing
Method
getBuildings
Example: Available for a 12-month lease
numberstring | nullnullablerequired
The unit number
Method
getBuildings
Example: 204
rent_amount_in_centsnumber | nullnullablerequired
The rent amount in cents for the listing
Method
getBuildings
Example: 185000
specialsstring | nullnullablerequired
Marketing specials or promotions for the listing
Method
getBuildings
Example: One month free on a 13-month lease
square_feetinteger | nullnullablerequired
The square footage of the listing
Method
getBuildings
Possible values: >= 0
Example: 1100
statestring | nullnullablerequired
The state associated with the listing
Method
getBuildings
Example: TX
street_address_1string | nullnullablerequireddeprecated
Deprecated: Use address_1
Method
getBuildings
street_address_2string | nullnullablerequireddeprecated
Deprecated: Use address_2
Method
getBuildings
address_1string | nullnullablerequired
The first address line associated with the listing
Method
getBuildings
Example: 1200 Market Street
address_2string | nullnullablerequired
The second address line associated with the listing
Method
getBuildings
Example: 1200 Market Street
property_descriptionstring | nullnullablerequired
Description of the property
Method
getBuildings
Example: Garden-style community near downtown
short_descriptionstring | nullnullablerequired
A short description of the listing
Method
getBuildings
Example: Updated 2 bedroom with in-unit laundry
unit_descriptionnullrequired
Description of the unit
Notice
This field will always be null for PROPERTYWARE
Example: null
zipstring | nullnullablerequired
The zip code associated with the listing
Method
getBuildings
Example: 78701
make_ready_datenullrequired
The make ready date of the listing
Notice
This field will always be null for PROPERTYWARE
Example: null
vacate_datenullrequired
The vacate date of the listing
Notice
This field will always be null for PROPERTYWARE
Example: null
video_urlsnullrequired
A list of video urls associated with the listing
Notice
This field will always be null for PROPERTYWARE
Example: null
status_rawstring | nullnullablerequired
The raw status associated with the listing
Method
getBuildings
Example: Vacant
property_idstringrequired
The Propexo unique identifier for the property
Example: clwi5xiix000008l6ctdgafyh
unit_idstring | nullnullablerequired
The Propexo unique identifier for the unit
Method
getBuildings
Example: cm0unitx00008pw0za63zbjzp
floor_plan_idnullrequired
The Propexo unique identifier for the floor plan
Notice
This field will always be null for PROPERTYWARE
Example: null
integration_idstringrequired
The Propexo unique identifier for the integration
Example: clwh5u07w000508me66sfh3um
integration_vendorEnum17required
The property management system of record
Show 13 enum values
PROPERTYWAREAPPFOLIOBUILDIUMENTRATAMRIPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST
Example: PROPERTYWARE
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 PROPERTYWARE
Example: null
unit_type_idnullrequired
The Propexo unique identifier for the unit type
Notice
This field will always be null for PROPERTYWARE
Example: null

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/listings/:listing_id

curl https://api.propexo.com/v1/listings/:listing_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": "902114",
    "x_property_id": "481920",
    "x_unit_id": "902114",
    "x_floor_plan_id": null,
    "is_unit": true,
    "available_date": "2025-04-01T00:00:00.000Z",
    "application_url": "https://oakapartments.propertyware.com/forsale.html?uid=902114",
    "bathrooms": "2.5",
    "bathrooms_full": 2,
    "bathrooms_half": 1,
    "bedrooms": "2",
    "building_name": "Oak Apartments",
    "building_number": null,
    "city": "Austin",
    "country": "USA",
    "custom_data": "Unknown Type: object,null",
    "deposit_amount_in_cents": 150000,
    "floor_plan_code": null,
    "floor_plan_name": null,
    "floor": "2",
    "image_urls": null,
    "is_available": true,
    "is_furnished": null,
    "is_listed": true,
    "is_managed_external": null,
    "is_vacant": true,
    "lease_term": "12 Months",
    "listing_title": "Spacious 2 Bedroom",
    "listing_date": null,
    "marketing_name": "Oak Apartments",
    "notes": "Available for a 12-month lease",
    "number": "204",
    "rent_amount_in_cents": 185000,
    "specials": "One month free on a 13-month lease",
    "square_feet": 1100,
    "state": "TX",
    "address_1": "1200 Market Street",
    "address_2": "1200 Market Street",
    "property_description": "Garden-style community near downtown",
    "short_description": "Updated 2 bedroom with in-unit laundry",
    "unit_description": null,
    "zip": "78701",
    "make_ready_date": null,
    "vacate_date": null,
    "video_urls": null,
    "status_raw": "Vacant",
    "property_id": "clwi5xiix000008l6ctdgafyh",
    "unit_id": "cm0unitx00008pw0za63zbjzp",
    "floor_plan_id": null,
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "PROPERTYWARE",
    "x_location_id": null,
    "unit_type_id": null
  }
}