Get an amenity by ID | Propexo

curl https://api.propexo.com/v1/amenities/amenity_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/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": "YARDI_AMENITY_987654",
    "x_property_id": "YARDI_PROPERTY_123456",
    "custom_data": {},
    "description": "Standard built-in microwave oven included in the kitchen.",
    "is_unit_amenity": true,
    "name_normalized": "MICROWAVE",
    "name": "microwave oven",
    "units": [
      {
        "amenity_id": "cm2j4ivcv0000eioz6rd365se",
        "unit_id": "cm2j4jbzf0002eiozdudz9bda"
      }
    ],
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "YARDI",
    "property_id": "clwi5xiix000008l6ctdgafyh"
  }
}

Get an amenity by ID 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.

Authentication

AuthorizationBearer

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

Path parameters

amenity_idstringRequired

The ID of the resource.

Query parameters

order-bystringOptionalDefaults to 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

offsetinteger or nullOptional>=0Defaults to 0

Can be used for paginating results

limitinteger or nullOptional0-250Defaults to 100

A number between 1 and 250 to determine the number of results to return in a single query

Response

Successful response

metaobject

resultsobject

Errors

400

Bad Request Error