Amenities

Get all amenities

GET

Get all amenities

Query parameters

order-bystringOptional

offsetintegerOptional

limitintegerOptional

x_idstringOptional

location_idstringOptional

property_idstringOptional

integration_idstringOptional

integration_vendorenumOptional

The property management system of record

Response

This endpoint returns an object

meta

object

results

list of objects

GET

1 curl https://api.propexo.com/v1/amenities \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "meta": {
3     "orderBy": [
4       {}
5     ],
6     "offset": 1,
7     "limit": 1,
8     "hasMore": true,
9     "total": 1
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       "x_id": "sample_value",
17       "x_property_id": "sample_value",
18       "image_urls": [
19         "image_urls"
20       ],
21       "name": "sample_value",
22       "units": [
23         {
24           "amenity_id": "amenity_id",
25           "unit_id": "unit_id"
26         }
27       ],
28       "integration_id": "clwh5u07w000508me66sfh3um",
29       "integration_vendor": "BUILDIUM",
30       "property_id": "clwi5xiix000008l6ctdgafyh",
31       "last_seen": "2024-03-22T10:59:45.119Z",
32       "x_listing_id": "x_listing_id",
33       "x_parent_amenity_id": "null",
34       "x_unit_id": "sample_value",
35       "cost_in_cents": 125000,
36       "description": "null",
37       "name_normalized": "ACCENT_WALLS"
38     }
39   ]
40 }

Built with

1	curl https://api.propexo.com/v1/amenities \
2	-H "Authorization: Bearer <token>"

1	{
2	"meta": {
3	"orderBy": [
4	{}
5	],
6	"offset": 1,
7	"limit": 1,
8	"hasMore": true,
9	"total": 1
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	"x_id": "sample_value",
17	"x_property_id": "sample_value",
18	"image_urls": [
19	"image_urls"
20	],
21	"name": "sample_value",
22	"units": [
23	{
24	"amenity_id": "amenity_id",
25	"unit_id": "unit_id"
26	}
27	],
28	"integration_id": "clwh5u07w000508me66sfh3um",
29	"integration_vendor": "BUILDIUM",
30	"property_id": "clwi5xiix000008l6ctdgafyh",
31	"last_seen": "2024-03-22T10:59:45.119Z",
32	"x_listing_id": "x_listing_id",
33	"x_parent_amenity_id": "null",
34	"x_unit_id": "sample_value",
35	"cost_in_cents": 125000,
36	"description": "null",
37	"name_normalized": "ACCENT_WALLS"
38	}
39	]
40	}