{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/customamenities","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"propertyUid","type":"string","default":"","desc":"The unique ID of the property","required":true,"in":"query","ref":"","_id":"56f4694e6bd7a20e00d22b05"}],"results":{"codes":[{"name":"","code":"[\n  {\n    \"id\": 23,\n    \"name\" : \"Free parking\"\n  }\n]","language":"json","status":200},{"status":400,"name":"","code":"Orbirental API - Bad request.","language":"text"},{"language":"text","status":409,"code":"Orbirental API - Property not found."}]},"settings":""},"next":{"description":"","pages":[]},"title":"/customamenities","type":"endpoint","slug":"customamenities","excerpt":"Query all custom amenities for a given property","body":"","updates":[],"order":8,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5de85dbbb0b885003ddf334b","editedParams2":true,"user":"56e371538b32a10e00f79750","project":"56e3719a591f620e00bf5095","version":{"version":"1.5","version_clean":"1.5.0","codename":"Domain","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5de85dbbb0b885003ddf3334","56e7b24ad365390e007baeab","5de85dbbb0b885003ddf3335","5de85dbbb0b885003ddf3336","5de85dbbb0b885003ddf3337","5de85dbbb0b885003ddf3338"],"_id":"5de85dbbb0b885003ddf339f","__v":0,"project":"56e3719a591f620e00bf5095","forked_from":"56e3719a591f620e00bf5098","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z"},"createdAt":"2016-03-24T22:25:18.649Z","__v":0,"category":{"sync":{"isSync":false,"url":""},"pages":["5de85dbbb0b885003ddf3339","5de85dbbb0b885003ddf333a","5de85dbbb0b885003ddf333b","5de85dbbb0b885003ddf333c","5de85dbbb0b885003ddf333d","5de85dbbb0b885003ddf333e","5de85dbbb0b885003ddf333f","5de85dbbb0b885003ddf3340","5de85dbbb0b885003ddf3341","5de85dbbb0b885003ddf3342","5de85dbbb0b885003ddf3343","56e77e22911296190096de13","5de85dbbb0b885003ddf3344","5de85dbbb0b885003ddf3345","5de85dbbb0b885003ddf3346","5de85dbbb0b885003ddf3347","5de85dbbb0b885003ddf3348","5de85dbbb0b885003ddf3349","5de85dbbb0b885003ddf334a"],"title":"Documentation","slug":"documentation","order":0,"from_sync":false,"reference":false,"_id":"5de85dbbb0b885003ddf3334","project":"56e3719a591f620e00bf5095","__v":19,"createdAt":"2016-03-12T01:32:11.359Z","version":"5de85dbbb0b885003ddf339f"},"editedParams":true,"githubsync":"","parentDoc":null}

get/customamenities

Query all custom amenities for a given property

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

propertyUid:
required
string
The unique ID of the property

Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}