Get all amenities | Propexo

curl https://api.propexo.com/v1/amenities/ \
     -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_listing_id": null,
      "x_parent_amenity_id": null,
      "x_property_id": "YARDI_PROPERTY_123456",
      "cost_in_cents": null,
      "custom_data": {},
      "description": "Microwave oven included in the unit kitchen",
      "image_urls": null,
      "is_unit_amenity": true,
      "meta_data": null,
      "name_normalized": "MICROWAVE",
      "name": "Microwave Oven",
      "units": [
        {
          "amenity_id": "cm2j4ivcv0000eioz6rd365se",
          "unit_id": "cm2j4jbzf0002eiozdudz9bda",
          "cost_in_cents": null
        }
      ],
      "integration_id": "clwh5u07w000508me66sfh3um",
      "integration_vendor": "YARDI",
      "property_id": "clwi5xiix000008l6ctdgafyh",
      "x_unit_id": null
    }
  ]
}

Get all amenities. 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.

curl https://api.propexo.com/v1/amenities/ \
     -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_listing_id": null,
      "x_parent_amenity_id": null,
      "x_property_id": "YARDI_PROPERTY_123456",
      "cost_in_cents": null,
      "custom_data": {},
      "description": "Microwave oven included in the unit kitchen",
      "image_urls": null,
      "is_unit_amenity": true,
      "meta_data": null,
      "name_normalized": "MICROWAVE",
      "name": "Microwave Oven",
      "units": [
        {
          "amenity_id": "cm2j4ivcv0000eioz6rd365se",
          "unit_id": "cm2j4jbzf0002eiozdudz9bda",
          "cost_in_cents": null
        }
      ],
      "integration_id": "clwh5u07w000508me66sfh3um",
      "integration_vendor": "YARDI",
      "property_id": "clwi5xiix000008l6ctdgafyh",
      "x_unit_id": null
    }
  ]
}

Authentication

AuthorizationBearer

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

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

updated_at_gtestring or nullOptional

Filter to records updated at or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)

updated_at_ltestring or nullOptional

Filter to records updated at or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)

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

x_idstringOptional

The external ID from the integration vendor

location_idstringOptional

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.

property_idstringOptional

The Propexo unique identifier for the property

integration_idstringOptional

The Propexo unique identifier for the integration

integration_vendorenumOptional

The property management system of record

unit_idstringOptional

The Propexo unique identifier for the unit

Response

Successful response

metaobject

resultslist of objects

Errors

400

Bad Request Error

$	curl https://api.propexo.com/v1/amenities/ \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"

1	{
2	"meta": {
3	"orderBy": [
4	{}
5	],
6	"offset": 0,
7	"limit": 100,
8	"hasMore": true,
9	"total": 1000
10	},
11	"results": [
12	{
13	"id": "clwktsp9v000008l31iv218hn",
14	"created_at": "2024-03-21T15:38:08.337Z",
15	"updated_at": "2024-03-22T10:59:45.119Z",
16	"last_seen": "2024-03-22T10:59:45.119Z",
17	"x_id": "YARDI_AMENITY_987654",
18	"x_listing_id": null,
19	"x_parent_amenity_id": null,
20	"x_property_id": "YARDI_PROPERTY_123456",
21	"cost_in_cents": null,
22	"custom_data": {},
23	"description": "Microwave oven included in the unit kitchen",
24	"image_urls": null,
25	"is_unit_amenity": true,
26	"meta_data": null,
27	"name_normalized": "MICROWAVE",
28	"name": "Microwave Oven",
29	"units": [
30	{
31	"amenity_id": "cm2j4ivcv0000eioz6rd365se",
32	"unit_id": "cm2j4jbzf0002eiozdudz9bda",
33	"cost_in_cents": null
34	}
35	],
36	"integration_id": "clwh5u07w000508me66sfh3um",
37	"integration_vendor": "YARDI",
38	"property_id": "clwi5xiix000008l6ctdgafyh",
39	"x_unit_id": null
40	}
41	]
42	}