Get all listings

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

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 listing id

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.

unit_id string

The Propexo unique identifier for the unit

property_id string

The Propexo unique identifier for the property

integration_id string

The Propexo integration id

integration_vendor string

Show 13 enum values

APPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST

The integration vendor for the listing.

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 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
Important
ResMan's legacy ID doesn't expose a unique ID, so Propexo uses the name as part of how we uniquely identify the floor plan. In the unlikely event that the name were to change, a new floor plan record would be created.
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: sdPFT6040dA8y8lCPYd87tpdFtLASs
x_property_idstringrequired
The external ID of the property from the integration vendor
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: ea387f8a-f93c-439f-80dd-29d6080c52cc
x_unit_idstring | nullnullablerequired
The external ID of the unit from the integration vendor
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: 101
x_floor_plan_idstring | nullnullablerequired
The external ID of the floor plan from the integration vendor
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: 44069f6273ff0fea0900E2687251666b3ccadf8d1ccf582b30b34ae0d979d5b5
is_unitbooleanrequired
True if the listing is for a unit, false if it is not associated with a specific unit
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: true
available_datestring | nullnullablerequired
The date the listing is available
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: 2023-02-05T00:00:00.000Z
application_urlstring | nullnullablerequired
The application URL for the listing
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: https://property-url.myresman.com/Portal/Applicants/ExampleURL
bathroomsstring | nullnullablerequired
The number of bathrooms associated with the listing
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: 1.5
bathrooms_fullnumber | nullnullablerequired
The number of full bathrooms associated with the listing
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: 1
bathrooms_halfnumber | nullnullablerequired
The number of half bathrooms associated with the listing
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: 1
bedroomsstring | nullnullablerequired
The number of bedrooms associated with the listing
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: 2
building_namestring | nullnullablerequired
The building name associated with the listing
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: Gateway Court
building_numbernullrequired
The building number associated with the listing
Notice
This field will always be null for RESMAN
Example: null
citystring | nullnullablerequired
The city associated with the listing
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: Burlington
countrystring | nullnullablerequired
The country associated with the listing
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: United States
custom_data object | nullrequired
object
deposit_amount_in_centsnumber | nullnullablerequired
The deposit amount in cents associated with the listing
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: 35000
floor_plan_codestring | nullnullablerequired
The external ID of the floor plan associated with the listing
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: A4 WASHINGTON
floor_plan_namestring | nullnullablerequired
The floor plan name associated with the listing
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: Washington - 2 Bedroom, 2 Bathroom
floorstring | nullnullablerequired
The floor number/name associated with the listing
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: 2
image_urlsstring[]required
A list of image urls associated with the listing
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: ["https://cdn.example.com/listings/unit-204.jpg"]
is_availableboolean | nullnullablerequired
Whether the listing is available
Important
A unit is considered available if it has a residential economic status and is either vacant and available for lease, or currently occupied but on notice to vacate.
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: true
is_furnishednullrequired
Whether the listing is furnished
Notice
This field will always be null for RESMAN
Example: null
is_listedboolean | nullnullablerequired
Whether the listing is listed
Important
Set to true if the unit has a unit-specific availability URL, otherwise false.
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: true
is_managed_externalnullrequired
Whether the listing is managed externally
Notice
This field will always be null for RESMAN
Example: null
is_vacantboolean | nullnullablerequired
Whether the listing is vacant
Interface	Method
Marketing	/MITS/GetMarketing4_0
lease_termstring | nullnullablerequired
The term of the lease
Important
Lease Term contains the default lease term for the property. The ResMan response payload may also include a list of available lease terms and prices for each listing. Please contact support if you'd like to get this additional metadata added to custom_data.
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: 12 months
listing_titlenullrequired
The title used for the marketing listing
Notice
This field will always be null for RESMAN
Example: null
listing_datenullrequired
The date the listing was created
Notice
This field will always be null for RESMAN
Example: null
marketing_namestring | nullnullablerequired
The marketing name of the unit being listed
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: 210
notesnullrequired
Notes associated with the listing
Notice
This field will always be null for RESMAN
Example: null
numberstring | nullnullablerequired
The unit number
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: 210
rent_amount_in_centsnumber | nullnullablerequired
The rent amount in cents for the listing
Important
This field is populated with the market rent for the unit. Alternatively, rent for a specific lease term may be available on the listing. Please contact support if you'd like to get this additional metadata added to custom_data.
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: 175000
specialsnullrequired
Marketing specials or promotions for the listing
Notice
This field will always be null for RESMAN
Example: null
square_feetinteger | nullnullablerequired
The square footage of the listing
Important
ResMan does not provide the square footage for any specific listing, rather the PMS provides a range of square footage based on the floor plan. Please contact support if you'd like to get the min and max range populated in custom data.
Interface	Method
Marketing	/MITS/GetMarketing4_0
Possible values: >= 0
Example: 997
statestring | nullnullablerequired
The state associated with the listing
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: CA
street_address_1string | nullnullablerequireddeprecated
Deprecated: Use address_1
Interface	Method
Marketing	/MITS/GetMarketing4_0
street_address_2string | nullnullablerequireddeprecated
Deprecated: Use address_2
Interface	Method
Marketing	/MITS/GetMarketing4_0
address_1string | nullnullablerequired
The first address line associated with the listing
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: 123 Main Street
address_2string | nullnullablerequired
The second address line associated with the listing
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: 123 Main Street
property_descriptionstring | nullnullablerequired
Description of the property
Important
A shorter property description may also be available. Please contact support if you'd like to get this additional metadata added to custom_data.
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: An apartment in the heart of the city.
short_descriptionnullrequired
A short description of the listing
Notice
This field will always be null for RESMAN
Example: null
unit_descriptionnullrequired
Description of the unit
Important
ResMan does not have a description for the individual unit. If you need a description, we recommend loading a description for the associated floorplan.
Notice
This field will always be null for RESMAN
Example: null
zipstring | nullnullablerequired
The zip code associated with the listing
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: 90210
make_ready_datestring | nullnullablerequired
The make ready date of the listing
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: 2023-02-10T00:00:00.000Z
vacate_datestring | nullnullablerequired
The vacate date of the listing
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: 2023-02-10T00:00:00.000Z
video_urlsnullrequired
A list of video urls associated with the listing
Notice
This field will always be null for RESMAN
Example: null
status_rawstring | nullnullablerequired
The raw status associated with the listing
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: Vacant
property_idstringrequired
The Propexo unique identifier for the property
Example: clwi5xiix000008l6ctdgafyh
unit_idstring | nullnullablerequired
The Propexo unique identifier for the unit
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: testintegration:1:101
floor_plan_idstring | nullnullablerequired
The Propexo unique identifier for the floor plan
Interface	Method
Marketing	/MITS/GetMarketing4_0
Example: cm9swl4kk3170431788sb33jf197doqo
integration_idstringrequired
The Propexo unique identifier for the integration
Example: clwh5u07w000508me66sfh3um
integration_vendorEnum23required
The property management system of record
Show 13 enum values
RESMANAPPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINEYARDIYARDI_REST
Example: RESMAN
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 RESMAN
Example: null
unit_type_idnullrequired
The Propexo unique identifier for the unit type
Notice
This field will always be null for RESMAN
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/

curl https://api.propexo.com/v1/listings/ \
     -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": "sdPFT6040dA8y8lCPYd87tpdFtLASs",
      "x_property_id": "ea387f8a-f93c-439f-80dd-29d6080c52cc",
      "x_unit_id": "101",
      "x_floor_plan_id": "44069f6273ff0fea0900E2687251666b3ccadf8d1ccf582b30b34ae0d979d5b5",
      "is_unit": true,
      "available_date": "2023-02-05T00:00:00.000Z",
      "application_url": "https://property-url.myresman.com/Portal/Applicants/ExampleURL",
      "bathrooms": "1.5",
      "bathrooms_full": 1,
      "bathrooms_half": 1,
      "bedrooms": "2",
      "building_name": "Gateway Court",
      "building_number": null,
      "city": "Burlington",
      "country": "United States",
      "custom_data": "Unknown Type: object,null",
      "deposit_amount_in_cents": 35000,
      "floor_plan_code": "A4 WASHINGTON",
      "floor_plan_name": "Washington - 2 Bedroom, 2 Bathroom",
      "floor": "2",
      "image_urls": [
        "https://cdn.example.com/listings/unit-204.jpg"
      ],
      "is_available": true,
      "is_furnished": null,
      "is_listed": true,
      "is_managed_external": null,
      "is_vacant": true,
      "lease_term": "12 months",
      "listing_title": null,
      "listing_date": null,
      "marketing_name": "210",
      "notes": null,
      "number": "210",
      "rent_amount_in_cents": 175000,
      "specials": null,
      "square_feet": 997,
      "state": "CA",
      "address_1": "123 Main Street",
      "address_2": "123 Main Street",
      "property_description": "An apartment in the heart of the city.",
      "short_description": null,
      "unit_description": null,
      "zip": "90210",
      "make_ready_date": "2023-02-10T00:00:00.000Z",
      "vacate_date": "2023-02-10T00:00:00.000Z",
      "video_urls": null,
      "status_raw": "Vacant",
      "property_id": "clwi5xiix000008l6ctdgafyh",
      "unit_id": "testintegration:1:101",
      "floor_plan_id": "cm9swl4kk3170431788sb33jf197doqo",
      "integration_id": "clwh5u07w000508me66sfh3um",
      "integration_vendor": "RESMAN",
      "x_location_id": null,
      "unit_type_id": null
    }
  ]
}