For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
How It WorksKnowledge BaseOnboardingVideo TutorialsPMS GuidanceAPI ReferenceRelease Notes
    • Overview
    • PMS Generic APIs
        • GETGet all amenities
        • POSTCreate amenity
        • GETGet an amenity by ID
        • PUTUpdate amenity
        • POSTCreate Amenities | Units
        • PUTUpdate amenities for unit
        • POSTCreate amenity for property
        • PUTUpdate amenities for property
    • CRM Generic APIs
    • PMS APIs
    • CRM APIs
    • Download OpenAPI Spec
Dashboard
LogoLogo
PMS Generic APIsAmenities

Get an amenity by ID

GET
/v1/amenities/:amenity_id
GET
/v1/amenities/:amenity_id
$curl https://api.propexo.com/v1/amenities/amenity_id \
>     -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    "id": "amnty_8f7a6b3c9d2e4f1a",
13    "created_at": "2023-11-15T09:30:00Z",
14    "updated_at": "2024-05-20T16:45:00Z",
15    "last_seen": "2024-05-19T12:00:00Z",
16    "x_id": "ext_amenity_12345",
17    "x_listing_id": "ext_listing_67890",
18    "x_parent_amenity_id": "ext_parent_amenity_54321",
19    "x_property_id": "ext_property_98765",
20    "cost_in_cents": 15000,
21    "custom_data": {},
22    "description": "Heated swimming pool available year-round with lounge chairs and poolside service.",
23    "image_urls": [
24      "https://loremflickr.com/640/480/pool"
25    ],
26    "is_unit_amenity": false,
27    "meta_data": {},
28    "name_normalized": "POOL",
29    "name": "Heated Swimming Pool",
30    "units": [
31      {
32        "amenity_id": "amnty_8f7a6b3c9d2e4f1a",
33        "unit_id": "unit_4b5c6d7e8f9a0b1c",
34        "cost_in_cents": 15000
35      }
36    ],
37    "integration_id": "intg_0011223344",
38    "integration_vendor": "APPFOLIO",
39    "property_id": "prop_5566778899",
40    "x_unit_id": "ext_unit_11223"
41  }
42}
Get an amenity by ID
Was this page helpful?
Previous

Update amenity

Next
Built with

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

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

Response

Successful response
metaobject
resultsobject

Errors

400
Bad Request Error