Skip to main content

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

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Common DataGetUnitInformation
    Example: 1234
    x_property_idstringrequired

    The external ID of the property from the integration vendor

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Common DataGetUnitInformation
    Example: clwqjwc1e000008i7fnrrayzc:23423:34634
    x_unit_idstring | nullnullablerequired

    The external ID of the unit from the integration vendor

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: 312441
    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
    is_unitnullrequired

    True if the listing is for a unit, false if it is not associated with a specific unit

    Notice

    This field will always be null for YARDI

    Example: null
    available_datestring | nullnullablerequired

    The date the listing is available

    InterfaceMethod
    Common DataGetUnitInformation
    Example: 2024-05-07T00:00:00.000Z
    application_urlnullrequired

    The application URL for the listing

    Notice

    This field will always be null for YARDI

    Example: null
    bathroomsstring | nullnullablerequired

    The number of bathrooms associated with the listing

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: 1.5
    bathrooms_fullnumber | nullnullablerequired

    The number of full bathrooms associated with the listing

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: 1
    bathrooms_halfnumber | nullnullablerequired

    The number of half bathrooms associated with the listing

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: 1
    bedroomsstring | nullnullablerequired

    The number of bedrooms associated with the listing

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: 2
    building_namestring | nullnullablerequired

    The building name associated with the listing

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: Englewood
    building_numbernullrequired

    The building number associated with the listing

    Notice

    This field will always be null for YARDI

    Example: null
    citystring | nullnullablerequired

    The city associated with the listing

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: Boston
    countrystring | nullnullablerequired

    The country associated with the listing

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: USA
    custom_data object | nullrequired
    object
    deposit_amount_in_centsnumber | nullnullablerequired

    The deposit amount in cents associated with the listing

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: 65000
    floor_plan_codenullrequired

    The external ID of the floor plan associated with the listing

    Notice

    This field will always be null for YARDI

    Example: null
    floor_plan_namestring | nullnullablerequired

    The floor plan name associated with the listing

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: Floorplan name from PMC
    floornullrequired

    The floor number/name associated with the listing

    Notice

    This field will always be null for YARDI

    Example: null
    image_urlsnullrequired

    A list of image urls associated with the listing

    Notice

    This field will always be null for YARDI

    Example: null
    is_availableboolean | nullnullablerequired

    Whether the listing is available

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: true
    is_furnishednullrequired

    Whether the listing is furnished

    Notice

    This field will always be null for YARDI

    Example: null
    is_listednullrequired

    Whether the listing is listed

    Notice

    This field will always be null for YARDI

    Example: null
    is_managed_externalnullrequired

    Whether the listing is managed externally

    Notice

    This field will always be null for YARDI

    Example: null
    is_vacantboolean | nullnullablerequired

    Whether the listing is vacant

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    lease_termnullrequired

    The term of the lease

    Notice

    This field will always be null for YARDI

    Example: null
    listing_titlenullrequired

    The title used for the marketing listing

    Notice

    This field will always be null for YARDI

    Example: null
    listing_datestring | nullnullablerequired

    The date the listing was created

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: 2024-05-07T00:00:00.000Z
    marketing_namenullrequired

    The marketing name of the unit being listed

    Notice

    This field will always be null for YARDI

    Example: null
    notesstring | nullnullablerequired

    Notes associated with the listing

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: Available in June
    numberstring | nullnullablerequired

    The unit number

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: R4
    rent_amount_in_centsnumber | nullnullablerequired

    The rent amount in cents for the listing

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: 75000
    specialsnullrequired

    Marketing specials or promotions for the listing

    Notice

    This field will always be null for YARDI

    Example: null
    square_feetinteger | nullnullablerequired

    The square footage of the listing

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login

    Possible values: >= 0

    Example: 1123
    statestring | nullnullablerequired

    The state associated with the listing

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: MA
    street_address_1string | nullnullablerequireddeprecated

    Deprecated: Use address_1

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    street_address_2string | nullnullablerequireddeprecated

    Deprecated: Use address_2

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    address_1string | nullnullablerequired

    The first address line associated with the listing

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: 123 Main St
    address_2string | nullnullablerequired

    The second address line associated with the listing

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: 123 Main St
    property_descriptionnullrequired

    Description of the property

    Notice

    This field will always be null for YARDI

    Example: null
    short_descriptionnullrequired

    A short description of the listing

    Notice

    This field will always be null for YARDI

    Example: null
    unit_descriptionnullrequired

    Description of the unit

    Notice

    This field will always be null for YARDI

    Example: null
    zipstring | nullnullablerequired

    The zip code associated with the listing

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: 02116
    make_ready_datestring | nullnullablerequired

    The make ready date of the listing

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: 2024-05-07T00:00:00.000Z
    vacate_datestring | nullnullablerequired

    The vacate date of the listing

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: 2024-05-07T00:00:00.000Z
    video_urlsnullrequired

    A list of video urls associated with the listing

    Notice

    This field will always be null for YARDI

    Example: null
    status_rawstring | nullnullablerequired

    The raw status associated with the listing

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: vacant
    property_idstringrequired

    The Propexo unique identifier for the property

    Example: clwi5xiix000008l6ctdgafyh
    unit_idstring | nullnullablerequired

    The Propexo unique identifier for the unit

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Example: clwqjwc1e000008i7fnrrayzc:lkeutd:1234
    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
    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 YARDI

    Example: null
    unit_type_idstring | nullnullablerequired

    The Propexo unique identifier for the unit type

    InterfaceMethod
    ILS Guest CardAvailableUnits_Login
    Common DataGetUnitInformation
    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/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": "1234",
    "x_property_id": "clwqjwc1e000008i7fnrrayzc:23423:34634",
    "x_unit_id": "312441",
    "x_floor_plan_id": null,
    "is_unit": null,
    "available_date": "2024-05-07T00:00:00.000Z",
    "application_url": null,
    "bathrooms": "1.5",
    "bathrooms_full": 1,
    "bathrooms_half": 1,
    "bedrooms": "2",
    "building_name": "Englewood",
    "building_number": null,
    "city": "Boston",
    "country": "USA",
    "custom_data": "Unknown Type: object,null",
    "deposit_amount_in_cents": 65000,
    "floor_plan_code": null,
    "floor_plan_name": "Floorplan name from PMC",
    "floor": null,
    "image_urls": null,
    "is_available": true,
    "is_furnished": null,
    "is_listed": null,
    "is_managed_external": null,
    "is_vacant": true,
    "lease_term": null,
    "listing_title": null,
    "listing_date": "2024-05-07T00:00:00.000Z",
    "marketing_name": null,
    "notes": "Available in June",
    "number": "R4",
    "rent_amount_in_cents": 75000,
    "specials": null,
    "square_feet": 1123,
    "state": "MA",
    "address_1": "123 Main St",
    "address_2": "123 Main St",
    "property_description": null,
    "short_description": null,
    "unit_description": null,
    "zip": "02116",
    "make_ready_date": "2024-05-07T00:00:00.000Z",
    "vacate_date": "2024-05-07T00:00:00.000Z",
    "video_urls": null,
    "status_raw": "vacant",
    "property_id": "clwi5xiix000008l6ctdgafyh",
    "unit_id": "clwqjwc1e000008i7fnrrayzc:lkeutd:1234",
    "floor_plan_id": null,
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "YARDI",
    "x_location_id": null,
    "unit_type_id": "clwqjwc1e000008i7fnrrayzc:322_fs:UnitTypeUniqueID-2344"
  }
}