{"_id":"5b0d88ec2f477900034b7aeb","project":"56e3719a591f620e00bf5095","version":{"_id":"56e3719a591f620e00bf5098","hasReference":true,"hasDoc":true,"__v":6,"project":"56e3719a591f620e00bf5095","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z","categories":["56e3719b591f620e00bf5099","56e7b24ad365390e007baeab","59c952f57f6bea002e57da0a","59c954f07f6bea002e57da14","59cb3f6b487a0e00261deb5c","59cd714c360c8600242c4984"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"category":{"_id":"56e3719b591f620e00bf5099","pages":["56e3719c591f620e00bf509b","56e74226555c030e00a52a90","56e7447c7d693632001d5cb4","56e752bd56d59a0e00d5660e","56e755b98aa2c00e00494cd9","56e7584d911296190096dd80","56e759339b25270e001d11a0","56e7593e1b41040e009d10cf","56e7594e911296190096dd88","56e7595e8aa2c00e00494ce3","56e75d7f5669091700c5b2b4","56e77e22911296190096de13","56e77f259b25270e001d1232","56e7b2c737afb90e00e0eb9d","56ec4daf611730190000f23f","56ec4fde26db830e00afa083","56ec8f7204e8940e00966567","56f184cc9791b22d0077b9d9","56f18a2c3af4942b00bb3c47"],"project":"56e3719a591f620e00bf5095","__v":19,"version":"56e3719a591f620e00bf5098","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-12T01:32:11.359Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"user":"5ad0d1d6d24f9c0003476a4c","githubsync":"","__v":2,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-05-29T17:07:56.265Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"name":"","code":"[{\n    \"lastLogin\": \"2018-05-20 10:33:41.0\",\n    \"lastName\": \"GuestLast\",\n    \"zipCode\": \"08837\",\n    \"linkedinURL\": \"www.linkedin.com/guestprofile\",\n    \"city\": \"California\",\n    \"airbnbID\": \"airbnbID\",\n    \"mobileNumber\": \"0987654321\",\n    \"pictureURL\": \"www.guestwebsite.com/image.jpg\",\n    \"adress\": \"Menlo Park\",\n    \"birthDate\": \"4 Dec 1994\",\n    \"favoriteAirline\": \"Alaska Airline\",\n    \"firstName\": \"GuestFirst\",\n    \"registrationToken\": \"NdbgHLH4Fa\",\n    \"skypeID\": \"skyoe_guest\",\n    \"facebookURL\": \"www.facebook.com/guestprofile\",\n    \"createdDate\": \"2018-05-20 10:33:41.0\",\n    \"phoneNumber\": \"123456789\",\n    \"agencyUid\": \"47d5b235-c98a-42c2-af89-b3bab325a7ff\",\n    \"profileNotes\": \"These are the notes of the Guest Account\",\n    \"id\": 57473,\n    \"state\": \"California\",\n    \"email\": \"guestemailid:::at:::guestcompany.com\",\n  \t\"uid\": \"47d5b235-c98a-42c2-af89-b3bab325a7ff\"\n},\n{\n    \"lastLogin\": \"2018-06-20 10:33:41.0\",\n    \"lastName\": \"GuestLast\",\n    \"zipCode\": \"08837\",\n    \"linkedinURL\": \"www.linkedin.com/guestprofile\",\n    \"city\": \"California\",\n    \"airbnbID\": \"airbnbID\",\n    \"mobileNumber\": \"0947654321\",\n    \"pictureURL\": \"www.guestwebsite.com/image.jpg\",\n    \"adress\": \"Menlo Park\",\n    \"birthDate\": \"5 Dec 1994\",\n    \"favoriteAirline\": \"Alaska Airline\",\n    \"firstName\": \"GuestFirstName\",\n    \"registrationToken\": \"NdbgHLH4Fa\",\n    \"skypeID\": \"skype_guest\",\n    \"facebookURL\": \"www.facebook.com/guestprofile\",\n    \"createdDate\": \"2018-04-20 10:33:41.0\",\n    \"phoneNumber\": \"1213456789\",\n    \"agencyUid\": \"47d5b235-c98a-42c2-af89-b3bab325a7ff\",\n    \"profileNotes\": \"These are the notes of the Guest Account\",\n    \"id\": 57474,\n    \"state\": \"California\",\n    \"email\": \"guestemailid1@guestcompany.com\",\n  \t\"uid\": \"46d5b235-c98a-42c2-af89-b3bab325a7ff\"\n}]","language":"json","status":200},{"code":"Orbirental API - Bad request.","language":"text","status":400},{"code":"Orbirental API - Invalid username or password.\n\nOrbirental API - Authorization Header missing.\n\nOrbirental API - Credentials missing.\n\nOrbirental API - Guest with provided email not found.\n\nOrbirental API - Invalid Password.","language":"text","status":409}]},"method":"get","examples":{"codes":[]},"auth":"required","params":[{"_id":"5b0d88ec2f477900034b7aec","ref":"","in":"query","required":true,"desc":"The unique ID of the agency","default":"","type":"string","name":"agencyUid"}],"url":"/guests"},"isReference":false,"order":15,"body":"","excerpt":"Get Guest Account Details","slug":"guests","type":"endpoint","title":"/guests"}

get/guests

Get Guest Account Details

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

agencyUid:
required
string
The unique ID of the agency

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