> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.propexo.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.propexo.com/_mcp/server. # Get an amenity by ID GET https://api.propexo.com/v1/amenities/{amenity_id} Get an amenity by ID Reference: https://docs.propexo.com/api-reference/yardi-rest/amenities/get-an-amenity-by-id ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Servers - `https://api.propexo.com` (Production, default) - `https://api.sandbox.propexo.com` (Sandbox) ## Request ### Path parameters - `amenity_id` (string, required) — The ID of the resource. ### Query parameters - `order-by` (string, optional, default: created_at:desc) — Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc - `updated_at_gte` (string, optional, nullable) — Filter to records updated at or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z) - `updated_at_lte` (string, optional, nullable) — Filter to records updated at or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z) - `last_seen_gte` (string, optional, nullable) — 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, optional, nullable) — 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, optional, nullable, default: 0) — Can be used for paginating results - `limit` (integer, optional, nullable, default: 100) — A number between 1 and 250 to determine the number of results to return in a single query ## Response ### 200 Successful response - `meta` (ResponseMeta, required) - `results` (V1AmenitiesAmenityIdGetOutputResults, required) ## Errors ### 400 Bad Request Error Bad Request - `error` (ErrorResponseError, required) ## Types ### ResponseMeta - `orderBy` (list of ResponseMetaOrderByItems, required) — The order of the results - `offset` (integer, optional) — The offset of the first result - `limit` (integer, optional) — The number of results to return - `hasMore` (boolean, optional, nullable) — Whether there are more results - `total` (integer, optional) — The total number of results ### V1AmenitiesAmenityIdGetOutputResults - `id` (string, required) — The Propexo unique identifier for the amenity - `created_at` (string, required) — The date record first entered Propexo - `updated_at` (string, required) — The date record was last updated in Propexo - `last_seen` (string, required, nullable) — The date the record was last seen from the PMS - `x_id` (string, required) — The external ID from the integration vendorAmenities 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. | Interface | Method | | -------------- | ----------------------------- | | ILS Guest Card | /ItfProspect/UnitAvailability | - `x_listing_id` (any, required) — The external ID of the listing from the integration vendorThis field will always be null for YARDI\_REST - `x_parent_amenity_id` (any, required) — The external ID from the integration vendor of the amenity this unit and/or property amenity is associated withThis field will always be null for YARDI\_REST - `x_property_id` (string, required) — The external ID of the property from the integration vendor | Interface | Method | |---|---| | ILS Guest Card | /ItfProspect/UnitAvailability | - `cost_in_cents` (any, required) — Cost in cents for the amenityThis field will always be null for YARDI\_REST - `custom_data` (V1AmenitiesAmenityIdGetOutputResultsCustomData, required, nullable) - `description` (string, required, nullable) — Description of the amenity | Interface | Method | |---|---| | ILS Guest Card | /ItfProspect/UnitAvailability | - `image_urls` (any, required) — A list of image urls associated with the amenityThis field will always be null for YARDI\_REST - `is_unit_amenity` (boolean, required, nullable) — Whether the amenity is a unit amenity | Interface | Method | |---|---| | ILS Guest Card | /ItfProspect/UnitAvailability | - `meta_data` (any, required) - `name_normalized` (enum, required) — The name associated with the amenity | Interface | Method | |---|---| | ILS Guest Card | /ItfProspect/UnitAvailability | - Allowed values: `ACCENT_WALLS`, `ACCEPTS_SMOKING`, `ADDITIONAL_STORAGE`, `AIR_CON`, `AIR_CONDITIONING_COMMERCIAL`, `AIR_CONDITIONING`, `ALARM`, `APPLIANCES_INCLUDED`, `AVAILABILITY_24_HOURS`, `BALCONY_OR_DECK_OR_PATIO`, `BALCONY`, `BASKETBALL_COURT`, `BEACH_ACCESS`, `BILINGUAL`, `BOAT_DOCKS`, `BROADBAND_INTERNET`, `BUSINESS_CENTER`, `CABLE_READY_COMMERCIAL`, `CABLE_READY`, `CABLE`, `CAR_WASH_AREA`, `CARPET`, `CARPORT`, `CEILING_FAN`, `CHILD_CARE`, `CLUB_DISCOUNT`, `CLUB_HOUSE`, `CONCIERGE`, `CONFERENCE_ROOM`, `CONTROLLED_ACCESS`, `COURTYARD`, `DISHWASHER`, `DISPOSAL`, `DOCK_HIGH_DOORS_OR_LOADING_AVAILABLE`, `DOOR_ATTENDANT`, `DOUBLE_SINK_VANITY`, `DRYER`, `ELECTRIC`, `ELEVATOR`, `FENCED_YARD`, `FIREPLACE`, `FITNESS_CENTER`, `FRAMED_MIRRORS`, `FREE_WEIGHTS`, `FREEZER`, `FURNISHED_AVAILABLE`, `FURNISHED`, `GAMING_STATIONS`, `GARAGE_PARKING`, `GARAGE`, `GAS`, `GATE`, `GROCERY_SERVICE`, `GRILL`, `GROUP_EXERCISE`, `GUEST_ROOM`, `HANDICAP_ACCESS`, `HANDRAILS`, `HARDWOOD_FLOORS`, `HEAT_ELECTRIC`, `HEAT_GAS`, `HEAT_OIL`, `HEAT`, `HEATING`, `HIGH_SPEED_INTERNET_COMMERCIAL`, `HIGH_SPEED_INTERNET`, `HOT_WATER`, `HOUSE_SITTING`, `HOUSEKEEPING`, `INDIVIDUAL_CLIMATE_CONTROL`, `INTERNET`, `ISLAND_KITCHEN`, `JOGGING_WALKING_TRAILS`, `LAKE_ACCESS`, `LAKE_FRONT`, `LAUNDRY`, `LAUNDRY_ROOM_OR_HOOKUPS`, `LAUNDRY_ROOM`, `LANDSCAPING`, `LIBRARY`, `LINEN_CLOSET`, `MEAL_SERVICE`, `MEDIA_ROOM`, `MICROWAVE`, `MULTI_USE_ROOM`, `NIGHT_PATROL`, `ON_SITE_MAINTENANCE`, `ON_SITE_MANAGEMENT`, `OTHER`, `OVEN_OR_RANGE`, `PACKAGE_RECEIVING`, `PANTRY`, `PARKING_COMMERCIAL`, `PARKING`, `PER_DIEM_ACCEPTED`, `PETS_ALLOWED`, `PING_PONG`, `PLAY_GROUND`, `POND`, `POOL`, `POWER`, `PRIVATE_BALCONY`, `PRIVATE_PATIO`, `RACQUETBALL`, `REC_ROOM`, `RECYCLING`, `REFRIGERATOR`, `SATELLITE`, `SAUNA`, `SECURITY`, `SEWER`, `SHORT_TERM_LEASE`, `SKYLIGHT`, `SMOKE_FREE`, `SNOW_REMOVAL`, `SPA`, `SPRINKLER_SYSTEM`, `STORAGE_UNITS`, `SUNDECK`, `TELEPHONE`, `TENNIS_COURT`, `TILE_FLOORING`, `TRANSPORTATION`, `TRASH`, `TV_LOUNGE`, `VALET_TRASH`, `VAULTED_CEILING`, `VIEW`, `VINTAGE`, `VINYL_FLOORING`, `VOLLEYBALL_COURT`, `WALK_IN_CLOSETS`, `WASHER`, `WATER`, `WD_HOOKUP`, `WD_IN_UNIT`, `WHEEL_CHAIR`, `WHEELCHAIR_ACCESS`, `WINDOW_COVERINGS`, `WIRELESS_INTERNET` - `name` (string, required) — The name associated with the amenity | Interface | Method | |---|---| | ILS Guest Card | /ItfProspect/UnitAvailability | - `units` (list of V1AmenitiesAmenityIdGetOutputResultsUnitsItems, required) — List of unit ids associated with the amenity - `integration_id` (string, required) — The Propexo unique identifier for the integration - `integration_vendor` (enum, required) — The property management system of record - Allowed values: `YARDI_REST`, `APPFOLIO`, `BUILDIUM`, `ENTRATA`, `MRI`, `PROPERTYWARE`, `PROPERTYWARE_REST`, `REALPAGE`, `REALPAGE_RPX`, `RENTMANAGER`, `RENTVINE`, `RESMAN`, `YARDI` - `property_id` (string, required) — The Propexo unique identifier for the property - `x_unit_id` (any, required, deprecated) — DEPRECATED: Please use the "units" field to see the associated units with this amenityThis field will always be null for YARDI\_REST ### ErrorResponseError - `code` (string, required) - `message` (string, required) - `details` (map from string to any, optional) ### ResponseMetaOrderByItems ### V1AmenitiesAmenityIdGetOutputResultsCustomData ### V1AmenitiesAmenityIdGetOutputResultsUnitsItems - `amenity_id` (string, required) — The Propexo unique identifier for the amenity | Interface | Method | |---|---| | ILS Guest Card | /ItfProspect/UnitAvailability | - `unit_id` (string, required) — The Propexo unique identifier for the unit | Interface | Method | |---|---| | ILS Guest Card | /ItfProspect/UnitAvailability | - `cost_in_cents` (any, required) — Cost in cents for the amenity on a particular unitThis field will always be null for YARDI\_REST ## Examples **Response** ```json { "meta": { "orderBy": [ {} ], "offset": 0, "limit": 100, "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": {}, "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", "x_unit_id": null } } ``` **SDK Code** ```python import requests url = "https://api.propexo.com/v1/amenities/amenity_id" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.propexo.com/v1/amenities/amenity_id'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.propexo.com/v1/amenities/amenity_id" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.propexo.com/v1/amenities/amenity_id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.propexo.com/v1/amenities/amenity_id") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.propexo.com/v1/amenities/amenity_id', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.propexo.com/v1/amenities/amenity_id"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.propexo.com/v1/amenities/amenity_id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```