Get an amenity by ID

GET

/v1/amenities/:amenity_id

Path parameters

amenity_idstringRequired

The ID of the resource.

Query parameters

order-bystringOptional

Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc

offsetintegerOptional

Can be used for paginating results

limitintegerOptional

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

Response

Successful response

metaobject

resultsobject

Errors

GET

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

1 {
2   "meta": {
3     "orderBy": [
4       {}
5     ],
6     "offset": 0,
7     "limit": 100,
8     "hasMore": true,
9     "total": 1000
10   },
11   "results": {
12     "id": "id",
13     "created_at": "created_at",
14     "updated_at": "updated_at",
15     "x_id": "x_id",
16     "x_property_id": "x_property_id",
17     "image_urls": [
18       "https://loremflickr.com/640/480/apartment"
19     ],
20     "name": "name",
21     "units": [
22       {
23         "amenity_id": "cm2j4ivcv0000eioz6rd365se",
24         "unit_id": "cm2j4jbzf0002eiozdudz9bda"
25       }
26     ],
27     "integration_id": "integration_id",
28     "integration_vendor": "SAMPLE2",
29     "property_id": "property_id",
30     "last_seen": "last_seen",
31     "x_listing_id": "x_listing_id",
32     "x_parent_amenity_id": "x_parent_amenity_id",
33     "cost_in_cents": 1.1,
34     "description": "description",
35     "name_normalized": "ACCENT_WALLS",
36     "x_unit_id": "x_unit_id"
37   }
38 }

Update amenity

Up Next

Built with

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

1	{
2	"meta": {
3	"orderBy": [
4	{}
5	],
6	"offset": 0,
7	"limit": 100,
8	"hasMore": true,
9	"total": 1000
10	},
11	"results": {
12	"id": "id",
13	"created_at": "created_at",
14	"updated_at": "updated_at",
15	"x_id": "x_id",
16	"x_property_id": "x_property_id",
17	"image_urls": [
18	"https://loremflickr.com/640/480/apartment"
19	],
20	"name": "name",
21	"units": [
22	{
23	"amenity_id": "cm2j4ivcv0000eioz6rd365se",
24	"unit_id": "cm2j4jbzf0002eiozdudz9bda"
25	}
26	],
27	"integration_id": "integration_id",
28	"integration_vendor": "SAMPLE2",
29	"property_id": "property_id",
30	"last_seen": "last_seen",
31	"x_listing_id": "x_listing_id",
32	"x_parent_amenity_id": "x_parent_amenity_id",
33	"cost_in_cents": 1.1,
34	"description": "description",
35	"name_normalized": "ACCENT_WALLS",
36	"x_unit_id": "x_unit_id"
37	}
38	}