{"_id":"56e74226555c030e00a52a90","parentDoc":null,"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"},"editedParams2":true,"project":"56e3719a591f620e00bf5095","user":"56e371538b32a10e00f79750","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"},"__v":13,"githubsync":"","editedParams":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-14T22:58:46.181Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"name":"","code":"[\n  {\n    \"uid\": \"72852a55-5be3-496c-904c-fc3fd261f0a4\",\n    \"childrenCount\": 0,\n    \"lastName\": \"Raudin\",\n    \"checkInDate\": \"2016-03-08\",\n    \"checkOutDate\": \"2016-03-12\",\n    \"status\": \"BOOKED\",\n    \"adultCount\": 1,\n    \"agency\": {\n      \"uid\": \"4f6a3a32-6d57-450d-8b46-12547854\",\n      \"name\": \"Responseev\"\n    },\n    \"property\": {\n      \"uid\": \"4f6a3a32-6d57-450d-8b46-44abb3b01994\",\n      \"isActive\": true,\n\t\t\t\"description\": \"This Point Reyes House is located on a quiet rural lane, 2 mns from the village of Point Reyes Station, just one hour north of downtown San Francisco.\",\n      \"baseGuests\": 4,\n      \"cleaningFeeAmount\": 160,\n      \"baseDailyRate\": 220,\n      \"acceptInstantBook\": false,\n      \"bathrooms\": \"2\",\n      \"maximumGuests\": 6,\n      \"state\": \"California\",\n      \"countryCode\": \"US\",\n      \"securityDepositAmount\": 500,\n      \"address1\": \"159 Campolindo Road\",\n      \"webLink\": \"http://point-reyes-vacation-rental.com/\",\n      \"address2\": \"\",\n      \"externalID\": \"\",\n      \"bedrooms\": 2,\n      \"type\": \"HOUSE\",\n      \"city\": \"Point Reyes Station\",\n      \"picture\": \"https://www.orbirental.com/img/uploader/livingroom4_1.jpg\",\n      \"postalCode\": \"94956\",\n      \"name\": \"The Quail's Nest Cottage\",\n      \"minimumStay\": 1,\n      \"availabilityCalendarUrl\" : \"https://www.orbirental.com/calendar/232.ics\",\n      \"photos\": [\n        {\n        \t\"url\": \"https://www.orbirental.com/img/uploader/view_0.jpg\",\n          \"description\" : \"my house\"\n        }\n    \t],\n      \"floor\": 2,\n      \"areaSize\": 30,\n      \"areaSizeUnit\": \"SQUARE_METERS\",\n      \"extraGuestFee\": 50,\n      \"taxationRate\": 12.5,\n      \"longitude\" : 48.1914945,\n      \"latitude\" : 19.1914945,\n      \"currency\": \"USD\"\n    },\n    \"stayDetails\": {\n       \"departureDate\": \"2017-02-25 11:00:00.0\",\n       \"arrivalDate\": \"2017-02-24 15:00:00.0\",\n       \"extraNotes\": \"Some notes\"\n     },\n    \"notes\": \"\",\n    \"email\": \"mike:::at:::yopmail.com\",\n    \"phoneNumber\": \"415-322-2422\",\n    \"cellphoneNumber\": \"415-888-6658\",\n    \"firstName\": \"Cedric\",\n    \"flightNumber\": \"XTF1PNS\",\n    \"reasonForTrip\": \"Business\",\n    \"preferredCurrency\": \"USD\",\n    \"petCount\": 1,\n    \"quoteAmount\": 200,\n    \"source\": \"ORBIRENTAL_FORM\",\n    \"city\": \"Irvine\",\n    \"state\": \"California\",\n    \"secondaryEmail\": \"mike@guest.airbnb.com\"\n  }\n]","language":"json","status":200},{"language":"text","status":400,"name":null,"code":"Orbirental API - Bad request."},{"code":"Orbirental API - Agency not found.","language":"text","status":409}]},"settings":"","auth":"required","params":[{"_id":"56e74226555c030e00a52a91","ref":"","in":"query","required":true,"desc":"the agency unique id on Orbirental","default":"","type":"string","name":"agencyUid"},{"_id":"57c9166a3df09d0e00c211e8","ref":"","in":"query","required":false,"desc":"String of property unique ids separate by \";\"","default":"","type":"string","name":"propertyUid"},{"_id":"58791dcc7304051b00e1dcf2","ref":"","in":"query","required":false,"desc":"Number of leads to retrieve","default":"10","type":"int","name":"limit"},{"_id":"58791dcc7304051b00e1dcf1","ref":"","in":"query","required":false,"desc":"","default":"0","type":"int","name":"offset"},{"_id":"58791dcc7304051b00e1dcf0","ref":"","in":"query","required":false,"desc":"Retrieve leads where checkin is after this date","default":"","type":"yyyy-mm-dd","name":"checkin_from"},{"_id":"58791dcc7304051b00e1dcef","ref":"","in":"query","required":false,"desc":"Retrieve leads where checkout is before this date","default":"","type":"yyyy-mm-dd","name":"checkout_to"},{"_id":"587d46a9cd6f210f00949bd4","ref":"","in":"query","required":false,"desc":"Retrieve leads where checkin is before this date","default":"","type":"yyyy-mm-dd","name":"checkin_to"},{"_id":"587d46a9cd6f210f00949bd3","ref":"","in":"query","required":false,"desc":"Retrieve leads where checkout is after this date","default":"","type":"yyyy-mm-dd","name":"checkout_from"},{"_id":"5b8bf2272c813300032c9cd1","ref":"","in":"query","required":false,"desc":"Retrieve leads filtered by the given status value","default":"","type":"string","name":"status"}],"url":"/leads"},"isReference":false,"order":24,"body":"Returns the last 1,000 leads associated with this agency, the most recent first.","excerpt":"Query all leads for a given agencyUid and (optionally) a propertyUid","slug":"leads-get","type":"endpoint","title":"/leads"}

get/leads

Query all leads for a given agencyUid and (optionally) a propertyUid

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

agencyUid:
required
string
the agency unique id on Orbirental
propertyUid:
string
String of property unique ids separate by ";"
limit:
integer10
Number of leads to retrieve
offset:
integer0
checkin_from:
yyyy-mm-dd
Retrieve leads where checkin is after this date
checkout_to:
yyyy-mm-dd
Retrieve leads where checkout is before this date
checkin_to:
yyyy-mm-dd
Retrieve leads where checkin is before this date
checkout_from:
yyyy-mm-dd
Retrieve leads where checkout is after this date
status:
string
Retrieve leads filtered by the given status value

Result Format


Documentation

Returns the last 1,000 leads associated with this agency, the most recent first.

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