{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/guests","auth":"required","settings":"","results":{"codes":[{"status":200,"language":"json","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\": \"[email protected]\",\n  \t\"uid\": \"46d5b235-c98a-42c2-af89-b3bab325a7ff\"\n}]","name":""},{"status":400,"language":"text","code":"Orbirental API - Bad request."},{"status":409,"language":"text","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."}]},"method":"get","examples":{"codes":[]},"params":[{"name":"agencyUid","type":"string","default":"","desc":"The unique ID of the agency","required":true,"in":"query","ref":"","_id":"5b0d88ec2f477900034b7aec"}]},"next":{"description":"","pages":[]},"title":"/guests","type":"endpoint","slug":"guests","excerpt":"Get Guest Account Details","body":"","updates":[],"order":22,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5de85dbbb0b885003ddf3385","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"},"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"},"user":"5ad0d1d6d24f9c0003476a4c","createdAt":"2018-05-29T17:07:56.265Z","githubsync":"","__v":2,"parentDoc":null}

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