{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/pincodes/","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"propertyUid","type":"string","default":"","desc":"The UID for this property.","required":true,"in":"query","ref":"","_id":"5c9f0cbe3b2366002dce29ef"},{"name":"lockType","type":"string","default":"","desc":"The type of lock: can be one of IGLOOHOME | RESORTLOCK | PARAKEET | AUGUST | VIRTUALKEY | OPERTO | OTHER","required":false,"in":"query","ref":"","_id":"5c9f0cbe3b2366002dce29ee"}],"results":{"codes":[{"name":"","code":"{\n  \"id\": 23,//the id of the pincode\n  \"propertyUid\": \"22418dd0-3b64-4fd1-a7d4-f093c47fc0d5\",//the uid of the associated property\n  \"type\": \"IGLOOHOME\",//the lock type for the pincode\n  \"startDateTime\": \"2001-07-04 12:08 PDT\",// date of format \"yyyy-MM-dd HH:mm Z\"\n\t\"endDateTime\": \"2001-09-04 12:08 PDT\",// date of format \"yyyy-MM-dd HH:mm Z\"  \n  \"pinCode\": \"5464862\",\n  \"leadUid\": \"22418dd0-3b64-4fd1-a7d4-f093c47fc0d3\",// optional\n  \"userEmail\": \"john:::at:::mycompany.com\"// optional\n}","language":"json","status":200}]},"settings":""},"next":{"description":"","pages":[]},"title":"/pincodes/","type":"endpoint","slug":"pincodes","excerpt":"Get all the existing pin codes associated with a specific property.","body":"","updates":[],"order":53,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5de85dbbb0b885003ddf335e","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"},"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"},"githubsync":"","user":"56e371538b32a10e00f79750","__v":13,"createdAt":"2017-01-05T01:08:32.930Z","parentDoc":null,"project":"56e3719a591f620e00bf5095"}

get/pincodes/

Get all the existing pin codes associated with a specific property.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

propertyUid:
required
string
The UID for this property.
lockType:
string
The type of lock: can be one of IGLOOHOME | RESORTLOCK | PARAKEET | AUGUST | VIRTUALKEY | OPERTO | OTHER

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 }}