Skip to main content

Get an amenity by ID

GEThttps://api.propexo.com/v1/amenities/:amenity_id

Authentication​

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

Path parameters​

amenity_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 amenity

    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

    Amenities only appear in the Yardi responses when they're associated with a unit or property and have a corresponding MITS amenity mapping value. To indicate a property level amenity only set a MITS property level mapping for that amenity. To indicate a unit level amenity only set a MITS unit level mapping for that amenity. To indicate a property level amenity that is also a unit level amenity, set a MITS property level mapping and a MITS unit level mapping.

    InterfaceMethod
    ILS Guest Card/ItfProspect/UnitAvailability
    Example: f63e1935e0407db3e74792856af0b2279f
    x_listing_idnullrequired

    The external ID of the listing from the integration vendor

    Notice

    This field will always be null for YARDI_REST

    Example: null
    x_parent_amenity_idnullrequired

    The external ID from the integration vendor of the amenity this unit and/or property amenity is associated with

    Notice

    This field will always be null for YARDI_REST

    Example: null
    x_property_idstringrequired

    The external ID of the property from the integration vendor

    InterfaceMethod
    ILS Guest Card/ItfProspect/UnitAvailability
    Example: 1234
    x_unit_idnullrequireddeprecated

    DEPRECATED: Please use the "units" field to see the associated units with this amenity

    Notice

    This field will always be null for YARDI_REST

    Example: null
    cost_in_centsnullrequired

    Cost in cents for the amenity

    Notice

    This field will always be null for YARDI_REST

    Example: null
    custom_data object | nullrequired
    object
    descriptionstring | nullnullablerequired

    Description of the amenity

    InterfaceMethod
    ILS Guest Card/ItfProspect/UnitAvailability
    Example: Pool
    image_urlsnullrequired

    A list of image urls associated with the amenity

    Notice

    This field will always be null for YARDI_REST

    Example: null
    is_unit_amenityboolean | nullnullablerequired

    Whether the amenity is a unit amenity

    InterfaceMethod
    ILS Guest Card/ItfProspect/UnitAvailability
    Example: true
    meta_datanullrequired
    Example: null
    name_normalizedstring | nullnullablerequired

    The name associated with the amenity

    InterfaceMethod
    ILS Guest Card/ItfProspect/UnitAvailability
    Show 140 enum values
    ACCENT_WALLSACCEPTS_SMOKINGADDITIONAL_STORAGEAIR_CONAIR_CONDITIONING_COMMERCIALAIR_CONDITIONINGALARMAPPLIANCES_INCLUDEDAVAILABILITY_24_HOURSBALCONY_OR_DECK_OR_PATIOBALCONYBASKETBALL_COURTBEACH_ACCESSBILINGUALBOAT_DOCKSBROADBAND_INTERNETBUSINESS_CENTERCABLE_READY_COMMERCIALCABLE_READYCABLECAR_WASH_AREACARPETCARPORTCEILING_FANCHILD_CARECLUB_DISCOUNTCLUB_HOUSECONCIERGECONFERENCE_ROOMCONTROLLED_ACCESSCOURTYARDDISHWASHERDISPOSALDOCK_HIGH_DOORS_OR_LOADING_AVAILABLEDOOR_ATTENDANTDOUBLE_SINK_VANITYDRYERELECTRICELEVATORFENCED_YARDFIREPLACEFITNESS_CENTERFRAMED_MIRRORSFREE_WEIGHTSFREEZERFURNISHED_AVAILABLEFURNISHEDGAMING_STATIONSGARAGE_PARKINGGARAGEGASGATEGROCERY_SERVICEGRILLGROUP_EXERCISEGUEST_ROOMHANDICAP_ACCESSHANDRAILSHARDWOOD_FLOORSHEAT_ELECTRICHEAT_GASHEAT_OILHEATHEATINGHIGH_SPEED_INTERNET_COMMERCIALHIGH_SPEED_INTERNETHOT_WATERHOUSE_SITTINGHOUSEKEEPINGINDIVIDUAL_CLIMATE_CONTROLINTERNETISLAND_KITCHENJOGGING_WALKING_TRAILSLAKE_ACCESSLAKE_FRONTLAUNDRYLAUNDRY_ROOM_OR_HOOKUPSLAUNDRY_ROOMLANDSCAPINGLIBRARYLINEN_CLOSETMEAL_SERVICEMEDIA_ROOMMICROWAVEMULTI_USE_ROOMNIGHT_PATROLON_SITE_MAINTENANCEON_SITE_MANAGEMENTOTHEROVEN_OR_RANGEPACKAGE_RECEIVINGPANTRYPARKING_COMMERCIALPARKINGPER_DIEM_ACCEPTEDPETS_ALLOWEDPING_PONGPLAY_GROUNDPONDPOOLPOWERPRIVATE_BALCONYPRIVATE_PATIORACQUETBALLREC_ROOMRECYCLINGREFRIGERATORSATELLITESAUNASECURITYSEWERSHORT_TERM_LEASESKYLIGHTSMOKE_FREESNOW_REMOVALSPASPRINKLER_SYSTEMSTORAGE_UNITSSUNDECKTELEPHONETENNIS_COURTTILE_FLOORINGTRANSPORTATIONTRASHTV_LOUNGEVALET_TRASHVAULTED_CEILINGVIEWVINTAGEVINYL_FLOORINGVOLLEYBALL_COURTWALK_IN_CLOSETSWASHERWATERWD_HOOKUPWD_IN_UNITWHEEL_CHAIRWHEELCHAIR_ACCESSWINDOW_COVERINGSWIRELESS_INTERNET
    Example: MICROWAVE
    namestringrequired

    The name associated with the amenity

    InterfaceMethod
    ILS Guest Card/ItfProspect/UnitAvailability
    Example: microwave oven
    units object[]required

    List of unit ids associated with the amenity

  • Array [
    • amenity_idstringrequired

    The Propexo unique identifier for the amenity

    InterfaceMethod
    ILS Guest Card/ItfProspect/UnitAvailability
    Example: 1234567890
    unit_idstringrequired

    The Propexo unique identifier for the unit

    InterfaceMethod
    ILS Guest Card/ItfProspect/UnitAvailability
    Example: 1234567890
    cost_in_centsnullrequired

    Cost in cents for the amenity on a particular unit

    Notice

    This field will always be null for YARDI_REST

    Example: null
  • ]
    • integration_idstringrequired

    The Propexo unique identifier for the integration

    Example: clwh5u07w000508me66sfh3um
    integration_vendorEnum25required

    The property management system of record

    Show 13 enum values
    YARDI_RESTAPPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDI
    Example: YARDI_REST
    property_idstringrequired

    The Propexo unique identifier for the property

    Example: clwi5xiix000008l6ctdgafyh

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/amenities/:amenity_id
curl https://api.propexo.com/v1/amenities/:amenity_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": "f63e1935e0407db3e74792856af0b2279f",
    "x_listing_id": null,
    "x_parent_amenity_id": null,
    "x_property_id": "1234",
    "cost_in_cents": null,
    "custom_data": "Unknown Type: object,null",
    "description": "Pool",
    "image_urls": null,
    "is_unit_amenity": true,
    "meta_data": null,
    "name_normalized": "MICROWAVE",
    "name": "microwave oven",
    "units": [
      {
        "amenity_id": "1234567890",
        "unit_id": "1234567890",
        "cost_in_cents": null
      }
    ],
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "YARDI_REST",
    "property_id": "clwi5xiix000008l6ctdgafyh"
  }
}