{"info":{"_postman_id":"cbeeb4b0-df98-49e3-a96f-c3814c8ede07","name":"Partners","description":"

Overview

\n

This document describes the endpoints available at https://partners.hirespace.com.

\n

This services exists so that our partners can use our venue data create experiences that support our mission to make venue booking a joy.

\n

Authentication

\n

We want you to create awesome stuff with our venue data and for you to be able to provide our venues with potential business as fast as possible. To make sure this can happen, we've made it super easy for you to access our API.

\n

All it requires is a Basic Authentication header with each request. Please contact your account manager at Hire Space, or speak to a Solutions Engineer, to request access credentials.

\n

Instant Booking

\n

Documentation for instant booking is not public and is only available to existing partners.

\n

Support

\n

For any support please or contact a Solutions Engineer who will discuss your issue.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"6140794","collectionId":"cbeeb4b0-df98-49e3-a96f-c3814c8ede07","publishedId":"RzfjnTbu","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-06-22T14:25:06.000Z"},"item":[{"name":"Add Enquiry","id":"f331e7bb-4f9e-4a57-b455-cd216303be18","request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"customer\": {\n\t\t\"email\": {\n\t\t\t\"value\": \"john.doe@acme.com\"\n\t\t},\n\t\t\"name\": {\n\t\t\t\"value\": \"John Doe\"\t\n\t\t},\n\t\t\"phone\": {\n\t\t\t\"value\": \"0207 099 2512\"\n\t\t},\n\t\t\"mobile\": {\n\t\t\t\"value\": \"+44 7970 099 052\"\n\t\t}\n\t}, \n\t\"enquiry\": {\n\t\t\"description\": {\n\t\t\t\"name\": \"Quarterly Company Update\",\n\t\t\t\"long\": \"We are planning to hold our Quarterly Company Update for 100 people. We'll need a AV so our CEO can present our results and will follow the speech with drinks (just beer/wine) and perhaps some bowl food\"\n\t\t},\n\t\t\"budget\": {\n\t\t\t\"currency\": \"GBP\",\n\t\t\t\"value\": 5000,\n\t\t\t\"type\": \"totalEvent\"\n\t\t},\n\t\t\"people\": {\n\t\t\t\"value\": 100,\n\t\t\t\"style\": \"reception\"\n\t\t},\n\t\t\"city\": {\n\t\t\t\"id\": 1\n\t\t},\n\t\t\"eventDates\": [\n\t\t\t{\n\t\t\t\t\"startDateTime\": \"2018-09-09T16:00:00.000Z\",\n\t\t\t\t\"endDateTime\": \"2018-09-09T21:00:00.000Z\"\n\t\t\t}\n\t\t],\n\t\t\"flexible\": {\n\t\t\t\"times\": false,\n\t\t\t\"dates\": false\n\t\t}\n\t}, \n\t\"enquiryLines\": [\n\t\t{\n\t\t\t\"usage\": {\n\t\t\t\t\"id\": 89329\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"usage\": {\n\t\t\t\t\"id\": 2382\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"usage\": {\n\t\t\t\t\"id\": 102838\n\t\t\t}\n\t\t}\n\t]\n}"},"url":"/api/v1/AddEnquiry","description":"

This endpoint allows partners to refer enquiries to Hire Space.

\n

All Enquiries referred by a partner to this endpoint:

\n\n

As a partner please ensure that sending customer data to this endpoint is covered by your privacy policy and that your customers are aware they will receive suggestions.

\n

You may make enquiries at unpublished usages if you have the Usage Id. There is no requirement to add any Enquiry Lines if you want to add an open ended brief.

\n

If Hire Space has received an enquiry from the email assocaited with the enquiry you are sending in the previous 48hrs, then Hire Space will not accept your enquiry as a referral.

\n

Further details of the information you can provide to AddEnquiry can be found here:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Field *(required)Allowed ValuesDescription
customer.email.value*
String		n/aThe email of the customer.
customer.name.value*
String		n/aThe name of the customer. The first word, as delimited by the first space, will be used as the customer's given name in any messages.
customer.phone.value*
String		n/aNot validated. This can be any international phone number.
customer.mobile.value
String		n/aMust be a UK phone number and Hire Space must have permission to send SMS \nmessages regarding their enquiry.
enquiry.description.name*
String		n/aA very short description, usually one word, which describes the event and is used in templates.
enquiry.description.long*
String		n/aA longer description of the requirements of the enquiry.
enquiry.budget.currency
String		n/aISO 4217 currency code.
enquiry.budget.value
Integer		n/aThe amount of money the customer is willing to spend.
enquiry.budget.type
String		totalEvent, venueHireOnlyThe type of enpenditure covered by the budget.
enquiry.people.value
Integer		n/aThe number of people who will be at the event
enquiry.people.style
String		boardroom, buffet, cabaret, classroom, dining, dinnerDance, reception, standing, theatre, uShaped, wedding, banquetThe format the people will be held in.
enquiry.location.city
String		n/aThe IATA 3-lettter city code of the city the enquiry relates to.
enquiry.location.country
String		n/aThe ISO 3166 Alpha-3 code of the country the enquiry relates to.
enquiry.location.latitude
Number		n/aThe latitude of the centre of the area the enquiry relates to.
enquiry.location.longitude
Number		n/aThe longitude of the centre of the area the enquiry relates to.
enquiry.location.radius
Number		n/aThe radius in kilometres from the latitude and longitude to define the area the enquiry relates to.
enquiry.eventDates[].startDateTime
ISO-8601		n/aThe start date/time of the enquiry. This is stored as an array and there may be many times. All times should be mutulally exclusive for a single enquiry.
enquiry.eventDates[].endDateTime
ISO-8601		n/aThe end date/time of the enquiry. This is stored as an array and there may be many times. All times should be mutulally exclusive for a single enquiry.
enquiry.flexible.times
Boolean		n/aA boolean value to indicate if the client canbe flexible over times.
enquiry.flexible.dates
Boolean		n/aA boolean value to indicate if the client canbe flexible over dates.
enquiryLines[].usage.id
Integer		n/aThe unique id of the usage associated with the enquiry line.
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"cbeeb4b0-df98-49e3-a96f-c3814c8ede07","id":"cbeeb4b0-df98-49e3-a96f-c3814c8ede07","name":"Partners","type":"collection"}},"urlObject":{"path":["api","v1","AddEnquiry"],"query":[],"variable":[]}},"response":[{"id":"62a0b7fc-d804-40c7-9fa3-af87bdc639fa","name":"Enquiry Rejected","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"customer\": {\n\t\t\"email\": {\n\t\t\t\"value\": \"john.doe@acme.com\"\n\t\t},\n\t\t\"name\": {\n\t\t\t\"value\": \"John Doe\"\t\n\t\t},\n\t\t\"phone\": {\n\t\t\t\"value\": \"0207 099 2512\"\n\t\t},\n\t\t\"mobile\": {\n\t\t\t\"value\": \"+44 7970 099 052\"\n\t\t}\n\t}, \n\t\"enquiry\": {\n\t\t\"description\": {\n\t\t\t\"name\": \"Quarterly Company Update\",\n\t\t\t\"long\": \"We are planning to hold our Quarterly Company Update for 100 people. We'll need a AV so our CEO can present our results and will follow the speech with drinks (just beer/wine) and perhaps some bowl food\"\n\t\t},\n\t\t\"budget\": {\n\t\t\t\"currency\": \"GBP\",\n\t\t\t\"value\": 5000,\n\t\t\t\"type\": \"totalEvent\"\n\t\t},\n\t\t\"people\": {\n\t\t\t\"value\": 100,\n\t\t\t\"style\": \"reception\"\n\t\t},\n\t\t\"location\": {\n\t\t\t\"city\": \"LDN\"\n\t\t},\n\t\t\"eventDates\": [\n\t\t\t{\n\t\t\t\t\"startDateTime\": \"2018-09-09T16:00:00.000Z\",\n\t\t\t\t\"endDateTime\": \"2018-09-09T21:00:00.000Z\"\n\t\t\t}\n\t\t],\n\t\t\"flexible\": {\n\t\t\t\"times\": false,\n\t\t\t\"dates\": false\n\t\t}\n\t}, \n\t\"enquiryLines\": [\n\t\t{\n\t\t\t\"usage\": {\n\t\t\t\t\"id\": 89329\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"usage\": {\n\t\t\t\t\"id\": 2382\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"usage\": {\n\t\t\t\t\"id\": 102838\n\t\t\t}\n\t\t}\n\t]\n}"},"url":"Api/v1/AddEnquiry"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Hire Space is already working on an enquiry from this customer which it has received in the last 48hrs. As such, Hire Space cannot accept this as a referral from you.\"\n}"},{"id":"a1a268fc-17ad-4f85-9b40-5b964cbc6fb2","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"customer\": {\n\t\t\"email\": {\n\t\t\t\"value\": \"john.doe@acme.com\"\n\t\t},\n\t\t\"name\": {\n\t\t\t\"value\": \"John Doe\"\t\n\t\t},\n\t\t\"phone\": {\n\t\t\t\"value\": \"0207 099 2512\"\n\t\t},\n\t\t\"mobile\": {\n\t\t\t\"value\": \"+44 7970 099 052\"\n\t\t}\n\t}, \n\t\"enquiry\": {\n\t\t\"description\": {\n\t\t\t\"name\": \"Quarterly Company Update\",\n\t\t\t\"long\": \"We are planning to hold our Quarterly Company Update for 100 people. We'll need a AV so our CEO can present our results and will follow the speech with drinks (just beer/wine) and perhaps some bowl food\"\n\t\t},\n\t\t\"budget\": {\n\t\t\t\"currency\": \"GBP\",\n\t\t\t\"value\": 5000,\n\t\t\t\"type\": \"totalEvent\"\n\t\t},\n\t\t\"people\": {\n\t\t\t\"value\": 100,\n\t\t\t\"style\": \"reception\"\n\t\t},\n\t\t\"location\": {\n\t\t\t\"city\": \"LDN\"\n\t\t},\n\t\t\"eventDates\": [\n\t\t\t{\n\t\t\t\t\"startDateTime\": \"2018-09-09T16:00:00.000Z\",\n\t\t\t\t\"endDateTime\": \"2018-09-09T21:00:00.000Z\"\n\t\t\t}\n\t\t],\n\t\t\"flexible\": {\n\t\t\t\"times\": false,\n\t\t\t\"dates\": false\n\t\t}\n\t}, \n\t\"enquiryLines\": [\n\t\t{\n\t\t\t\"usage\": {\n\t\t\t\t\"id\": 89329\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"usage\": {\n\t\t\t\t\"id\": 2382\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"usage\": {\n\t\t\t\t\"id\": 102838\n\t\t\t}\n\t\t}\n\t]\n}"},"url":"Api/v1/AddEnquiry"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"enquiry\": {\n\t\t\"id\": \"tuB4stS3yM8SBJtEp\"\n\t},\n\t\"enquiryLines\": [\n\t\t{\n\t\t\t\"id\": \"255hCgYzm6yvvji7b\"\n\t\t},\n\t\t\t\t{\n\t\t\t\"id\": \"2TskMisiCHj2kwRgg\"\n\t\t},\n\t\t\t\t{\n\t\t\t\"id\": \"388T6Jw6qSzrWTaQA\"\n\t\t}\n\t]\n}"}],"_postman_id":"f331e7bb-4f9e-4a57-b455-cd216303be18"},{"name":"Get Enquiries Since","id":"d870e730-ac94-462c-8240-3e5e89b9253f","request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"updatedSince\": \"2019-01-10T00:00:00.000Z\",\n\t\"limit\": 10, \n\t\"skip\": 0, \n\t\"projection\": {\n\t\t\"id\": true,\n\t\t\"status\": true,\n\t\t\"description\": true,\n\t\t\"city\": true,\n\t\t\"budget\": true,\n\t\t\"people\": true,\n\t\t\"eventDateTimes\": true,\n\t\t\"dateTimes\": true,\n\t\t\"enquiryLines.id\": true,\n\t\t\"enquiryLines.usage.id\": true,\n\t\t\"enquiryLines.space.id\": true,\n\t\t\"enquiryLines.venue.id\": true,\n\t\t\"enquiryLines.status\": true,\n\t\t\"enquiryLines.price\": true,\n\t\t\"enquiryLines.commission\": true,\n\t\t\"enquiryLines.dateTimes\": true\n\t}\n}"},"url":"/api/v1/GetEnquiriesUpdatedSince","description":"

This endpoint allows partners to poll the enquiries which they have referred to Hire Space.

\n

It is recommended that partners periodically keep the status of the enquiries they have referred up to date for their own tracking. This can be achieved by polling this endpoint on a hourly, daily or weekly basis. More than 100 requests per day will be blocked.

\n

Each authorisation username:password is associated with a partner and only enquiries that have been referred by the partner will be returned.

\n

By keeping the status of their enquiries up to date partners will gain:

\n\n

Further details of the information you can provide to GetEnquiriesUpdatedSince can be found here:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Field *(required)Allowed ValuesDescription
updatedSince*
ISO-8601		n/aThe time/date since which all edited enquiries will be retrieved.
limit
Integer		n/aThe maximum number of records to be returned.
skip
Integer		n/aThe number of records to skip before returning the results. The records will always be ordered by The Last Edited Date.
projection
Object		n/aAn object which determines which fields may be returned. Please note that dot notation can be used and that the full set of properties available is shown in the example response of these API docs.
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"cbeeb4b0-df98-49e3-a96f-c3814c8ede07","id":"cbeeb4b0-df98-49e3-a96f-c3814c8ede07","name":"Partners","type":"collection"}},"urlObject":{"path":["api","v1","GetEnquiriesUpdatedSince"],"query":[],"variable":[]}},"response":[{"id":"edc4ae25-d1e2-4c67-b1eb-0fe190b34c7a","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"updatedSince\": \"2019-01-10T00:00:00.000Z\",\n\t\"limit\": 10, \n\t\"skip\": 0, \n\t\"projection\": {\n\t\t\"id\": true,\n\t\t\"status\": true,\n\t\t\"description\": true,\n\t\t\"city\": true,\n\t\t\"budget\": true,\n\t\t\"people\": true,\n\t\t\"eventDateTimes\": true,\n\t\t\"dateTimes\": true,\n\t\t\"enquiryLines.id\": true,\n\t\t\"enquiryLines.usage.id\": true,\n\t\t\"enquiryLines.space.id\": true,\n\t\t\"enquiryLines.venue.id\": true,\n\t\t\"enquiryLines.status\": true,\n\t\t\"enquiryLines.price\": true,\n\t\t\"enquiryLines.commission\": true,\n\t\t\"enquiryLines.dateTimes\": true\n\t}\n}"},"url":"/api/v1/GetEnquiriesUpdatedSince"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n\t{\n\t\t\"enquiry\": {\n\t\t\t\"id\": \"tuB4stS3yM8SBJtEp\",\n\t\t\t\"status\": {\n\t\t\t\t\"value\": \"pending\"\n\t\t\t},\n\t\t\t\"description\": {\n\t\t\t\t\"name\": \"Quarterly Company Update\",\n\t\t\t\t\"long\": \"We are planning to hold our Quarterly Company Update for 100 people. We'll need a AV so our CEO can present our results and will follow the speech with drinks (just beer/wine) and perhaps some bowl food\"\n\t\t\t},\n\t\t\t\"budget\": {\n\t\t\t\t\"currency\": \"GBP\",\n\t\t\t\t\"value\": 5000,\n\t\t\t\t\"type\": \"totalEvent\"\n\t\t\t},\n\t\t\t\"people\": {\n\t\t\t\t\"value\": 100,\n\t\t\t\t\"style\": \"other-standing\"\n\t\t\t},\n\t\t\t\"city\": {\n\t\t\t\t\"id\": 1,\n\t\t\t\t\"name\": \"London\"\n\t\t\t},\n\t\t\t\"eventDateTimes\": [\n\t\t\t\t{\n\t\t\t\t\t\"startDateTime\": \"2018-09-09T16:00:00.000Z\",\n\t\t\t\t\t\"endDateTime\": \"2018-09-09T21:00:00.000Z\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"flexible\":{\n\t\t\t\t\"times\": false,\n\t\t\t\t\"dates\": false\n\t\t\t},\n\t\t\t\"dateTimes\": {\n\t\t\t\t\"created\": \"2018-04-12T16:12:00.000Z\",\n\t\t\t\t\"updated\": \"2018-04-15T11:18:00.000Z\",\n\t\t\t\t\"closed\": \"2018-04-15T11:18:00.000Z\"\n\t\t\t}\n\t\t}, \n\t\t\"enquiryLines\": [\n\t\t\t{\n\t\t\t\t\"id\": \"uBm5bx7TYyivgGrky\",\n\t\t\t\t\"usage\": {\n\t\t\t\t\t\"id\": 2312\n\t\t\t\t},\n\t\t\t\t\"space\": {\n\t\t\t\t\t\"id\": 1299\n\t\t\t\t},\n\t\t\t\t\"venue\": {\n\t\t\t\t\t\"id\": 232\n\t\t\t\t},\n\t\t\t\t\"status\": {\n\t\t\t\t\t\"value\": \"pending\"\n\t\t\t\t},\n\t\t\t\t\"dateTimes\": {\n\t\t\t\t\t\"created\": \"2018-04-12T16:12:00.000Z\",\n\t\t\t\t\t\"updated\": \"2018-04-14T16:12:00.000Z\"\n\t\t\t\t}\n\t\t\t\t\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"hZrhzM2DKk7fHJHvZ\",\n\t\t\t\t\"usage\": {\n\t\t\t\t\t\"id\": 89329\n\t\t\t\t},\n\t\t\t\t\"space\": {\n\t\t\t\t\t\"id\": 9879\n\t\t\t\t},\n\t\t\t\t\"venue\": {\n\t\t\t\t\t\"id\": 4987\n\t\t\t\t},\n\t\t\t\t\"status\": {\n\t\t\t\t\t\"value\": \"lost\"\n\t\t\t\t},\n\t\t\t\t\"price\": {\n\t\t\t\t\t\"currency\": \"GBP\",\n\t\t\t\t\t\"value\": 5500,\n\t\t\t\t\t\"type\": \"rough\"\n\t\t\t\t},\n\t\t\t\t\"dateTimes\": {\n\t\t\t\t\t\"created\": \"2018-04-12T16:12:00.000Z\",\n\t\t\t\t\t\"updated\": \"2018-04-15T11:18:00.000Z\",\n\t\t\t\t\t\"closed\": \"2018-04-15T11:18:00.000Z\"\n\t\t\t\t}\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"qTLh5xRe8PoA26ihZ\",\n\t\t\t\t\"usage\": {\n\t\t\t\t\t\"id\": 982\n\t\t\t\t},\n\t\t\t\t\"space\": {\n\t\t\t\t\t\"id\": 639\n\t\t\t\t},\n\t\t\t\t\"venue\": {\n\t\t\t\t\t\"id\": 129\n\t\t\t\t},\n\t\t\t\t\"status\": {\n\t\t\t\t\t\"value\": \"pending\"\n\t\t\t\t},\n\t\t\t\t\"price\": {\n\t\t\t\t\t\"currency\": \"GBP\",\n\t\t\t\t\t\"value\": 4650,\n\t\t\t\t\t\"type\": \"minimumSpend\"\n\t\t\t\t},\n\t\t\t\t\"dateTimes\": {\n\t\t\t\t\t\"created\": \"2018-04-12T16:12:00.000Z\",\n\t\t\t\t\t\"updated\": \"2018-04-14T16:12:00.000Z\"\n\t\t\t\t}\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"Y8XT7t8X92KdMWDsW\",\n\t\t\t\t\"usage\": {\n\t\t\t\t\t\"id\": 74933\n\t\t\t\t},\n\t\t\t\t\"space\": {\n\t\t\t\t\t\"id\": 21239\n\t\t\t\t},\n\t\t\t\t\"venue\": {\n\t\t\t\t\t\"id\": 8720\n\t\t\t\t},\n\t\t\t\t\"status\": {\n\t\t\t\t\t\"value\": \"pending\"\n\t\t\t\t},\n\t\t\t\t\"dateTimes\": {\n\t\t\t\t\t\"created\": \"2018-04-12T16:12:00.000Z\",\n\t\t\t\t\t\"updated\": \"2018-04-12T16:12:00.000Z\"\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t},\n\t{\n\t\t\"enquiry\": {\n\t\t\t\"id\": \"5ipmAkLXmeCLcLd6C\",\n\t\t\t\"status\": {\n\t\t\t\t\"value\": \"won\"\n\t\t\t},\n\t\t\t\"description\": {\n\t\t\t\t\"name\": \"Wedding Reception\",\n\t\t\t\t\"long\": \"We're based in the US but are looking to host our wedding somewhere near London so our family can attend. Ideally somewhere spectacular and traditional.\"\n\t\t\t},\n\t\t\t\"budget\": {\n\t\t\t\t\"currency\": \"GBP\",\n\t\t\t\t\"value\": 8000,\n\t\t\t\t\"type\": \"venueOnly\"\n\t\t\t},\n\t\t\t\"people\": {\n\t\t\t\t\"value\": 150,\n\t\t\t\t\"style\": \"seated-dinnerDance\"\n\t\t\t},\n\t\t\t\"city\": {\n\t\t\t\t\"id\": 2,\n\t\t\t\t\"name\": \"Manchester\"\n\t\t\t},\n\t\t\t\"eventDates\": [\n\t\t\t\t{\n\t\t\t\t\t\"startDateTime\": \"2019-06-01T13:00:00.000Z\",\n\t\t\t\t\t\"endDateTime\": \"2019-07-01T01:00:00.000Z\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"flexible\":{\n\t\t\t\t\"times\": false,\n\t\t\t\t\"dates\": false\n\t\t\t},\n\t\t\t\"dateTimes\": {\n\t\t\t\t\"created\": \"2018-04-11T13:29:00.000Z\",\n\t\t\t\t\"updated\": \"2019-01-05T09:57:00.000Z\",\n\t\t\t\t\"closed\": \"2018-05-12T11:38:00.000Z\"\n\t\t\t}\n\t\t}, \n\t\t\"enquiryLines\": [\n\t\t\t{\n\t\t\t\t\"id\": \"ssLLNAZ8wccYe7dEi\",\n\t\t\t\t\"usage\": {\n\t\t\t\t\t\"id\": 8479\n\t\t\t\t},\n\t\t\t\t\"space\": {\n\t\t\t\t\t\"id\": 4983\n\t\t\t\t},\n\t\t\t\t\"venue\": {\n\t\t\t\t\t\"id\": 3987\n\t\t\t\t},\n\t\t\t\t\"status\": {\n\t\t\t\t\t\"value\": \"won\"\n\t\t\t\t},\n\t\t\t\t\"price\": {\n\t\t\t\t\t\"currency\": \"GBP\",\n\t\t\t\t\t\"value\": 16500,\n\t\t\t\t\t\"type\": \"final\"\n\t\t\t\t},\n\t\t\t\t\"commission\": {\n\t\t\t\t\t\"fromVenueToHireSpace\": {\n\t\t\t\t\t\t\"currency\": \"GBP\",\n\t\t\t\t\t\t\"value\": 1650,\n\t\t\t\t\t\t\"paid\": false\n\t\t\t\t\t},\n\t\t\t\t\t\"fromHireSpaceToPartner\": {\n\t\t\t\t\t\t\"currency\": \"GBP\",\n\t\t\t\t\t\t\"value\": 165,\n\t\t\t\t\t\t\"paid\": false\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"dateTimes\": {\n\t\t\t\t\t\"created\": \"2018-04-11T13:29:00.000Z\",\n\t\t\t\t\t\"updated\": \"2019-01-05T09:57:00.000Z\",\n\t\t\t\t\t\"closed\": \"2018-05-12T11:38:00.000Z\",\n\t\t\t\t\t\"finalPrice\": \"2019-01-05T09:57:00.000Z\"\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t},\n\t{\n\t\t\"enquiry\": {\n\t\t\t\"id\": \"ihHep6s2f5SMozHYa\",\n\t\t\t\"status\": {\n\t\t\t\t\"value\": \"won\"\n\t\t\t},\n\t\t\t\"description\": {\n\t\t\t\t\"name\": \"Fashion Launch\",\n\t\t\t\t\"long\": \"We’re trying to find a space we can hire for 2 full days. Can’t be anything too ornate/beautiful. We talking an old warehouse, or industrial space. Has an edge. I would want to get 500 people in it.\"\n\t\t\t},\n\t\t\t\"city\": {\n\t\t\t\t\"id\": 1,\n\t\t\t\t\"name\": \"London\"\n\t\t\t},\n\t\t\t\"budget\": {\n\t\t\t\t\"currency\": \"GBP\",\n\t\t\t\t\"value\": 16500,\n\t\t\t\t\"type\": \"totalEvent\"\n\t\t\t},\n\t\t\t\"people\": {\n\t\t\t\t\"value\": 500,\n\t\t\t\t\"style\": \"other-standing\"\n\t\t\t},\n\t\t\t\"eventDateTimes\": [\n\t\t\t\t{\n\t\t\t\t\t\"startDateTime\": \"2019-02-11T09:00:00.000Z\",\n\t\t\t\t\t\"endDateTime\": \"2019-02-11T23:00:00.000Z\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"startDateTime\": \"2019-02-12T09:00:00.000Z\",\n\t\t\t\t\t\"endDateTime\": \"2019-02-12T23:00:00.000Z\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"flexible\":{\n\t\t\t\t\"times\": true,\n\t\t\t\t\"dates\": false\n\t\t\t},\n\t\t\t\"dateTimes\": {\n\t\t\t\t\"created\": \"2018-09-17T10:12:00.000Z\",\n\t\t\t\t\"updated\": \"2019-04-01T16:40:00.000Z\",\n\t\t\t\t\"closed\": \"2018-11-17T09:47:00.000Z\"\n\t\t\t}\n\t\t}, \n\t\t\"enquiryLines\": [\n\t\t\t{\n\t\t\t\t\"if\": \"ssLLNAZ8wccYe7dEi\",\n\t\t\t\t\"usage\": {\n\t\t\t\t\t\"id\": 3372\n\t\t\t\t},\n\t\t\t\t\"space\": {\n\t\t\t\t\t\"id\": 3980\n\t\t\t\t},\n\t\t\t\t\"venue\": {\n\t\t\t\t\t\"id\": 2738\n\t\t\t\t},\n\t\t\t\t\"status\": {\n\t\t\t\t\t\"value\": \"won\"\n\t\t\t\t},\n\t\t\t\t\"price\": {\n\t\t\t\t\t\"currency\": \"GBP\",\n\t\t\t\t\t\"value\": 21000,\n\t\t\t\t\t\"type\": \"final\"\n\t\t\t\t},\n\t\t\t\t\"commission\": {\n\t\t\t\t\t\"fromVenueToHireSpace\": {\n\t\t\t\t\t\t\"currency\": \"GBP\",\n\t\t\t\t\t\t\"value\": 2100,\n\t\t\t\t\t\t\"paid\": true\n\t\t\t\t\t},\n\t\t\t\t\t\"fromHireSpaceToPartner\": {\n\t\t\t\t\t\t\"currency\": \"GBP\",\n\t\t\t\t\t\t\"value\": 210,\n\t\t\t\t\t\t\"paid\": true\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"dateTimes\": {\n\t\t\t\t\t\"created\": \"2018-09-17T08:00:00.000Z\",\n\t\t\t\t\t\"updated\": \"2019-04-01T16:40:00.000Z\",\n\t\t\t\t\t\"closed\": \"2018-11-17T09:47:00.000Z\",\n\t\t\t\t\t\"finalPrice\": \"2019-01-17T13:10:00.000Z\",\n\t\t\t\t\t\"paidFromVenueToHS\": \"2019-03-19T14:42:00.000Z\",\n\t\t\t\t\t\"paidFromHireSpaceToPartner\": \"2019-04-01T16:40:00.000Z\"\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}\n]"}],"_postman_id":"d870e730-ac94-462c-8240-3e5e89b9253f"},{"name":"Get Enquiry","id":"230e80e8-5b7f-4211-8ac7-13d68fd9e3a5","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"projection\": {\n\t\t\"id\": true,\n\t\t\"status\": true,\n\t\t\"description\": true,\n\t\t\"city\": true,\n\t\t\"budget\": true,\n\t\t\"people\": true,\n\t\t\"eventDateTimes\": true,\n\t\t\"dateTimes\": true,\n\t\t\"enquiryLines.id\": true,\n\t\t\"enquiryLines.usage.id\": true,\n\t\t\"enquiryLines.space.id\": true,\n\t\t\"enquiryLines.venue.id\": true,\n\t\t\"enquiryLines.status\": true,\n\t\t\"enquiryLines.price\": true,\n\t\t\"enquiryLines.commission\": true,\n\t\t\"enquiryLines.dateTimes\": true\n\t}\n}"},"url":"/api/v1/GetEnquiry/:enquiryId","description":"

This endpoint allows partners to retrieve information about a specific enquiry they have referred to Hire Space.

\n

Partners may want to retrieve more detailed information about a specific enquiry and this endpoint allows them to do so.

\n

Each authorisation username:password is associated with a partner and only enquiries that have been referred by the partner will be returned.

\n

Further details of the information you can provide to GetEnquiry can be found here:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Field *(required)Allowed ValuesDescription
projection
Object		n/aAn object which determines which fields may be returned. Please note that dot notation can be used and that the full set of properties available is shown in the example response of these API docs.
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"cbeeb4b0-df98-49e3-a96f-c3814c8ede07","id":"cbeeb4b0-df98-49e3-a96f-c3814c8ede07","name":"Partners","type":"collection"}},"urlObject":{"path":["api","v1","GetEnquiry",":enquiryId"],"query":[],"variable":[{"description":{"content":"

The Enquiry Id of the enquiry to get

\n","type":"text/plain"},"type":"any","value":"ihHep6s2f5SMozHYa","key":"enquiryId"}]}},"response":[{"id":"0afccf2a-381e-4b5e-9fe8-3f4cd19c2565","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"projection\": {\n\t\t\"id\": true,\n\t\t\"status\": true,\n\t\t\"description\": true,\n\t\t\"city\": true,\n\t\t\"budget\": true,\n\t\t\"people\": true,\n\t\t\"eventDateTimes\": true,\n\t\t\"dateTimes\": true,\n\t\t\"enquiryLines.id\": true,\n\t\t\"enquiryLines.usage.id\": true,\n\t\t\"enquiryLines.space.id\": true,\n\t\t\"enquiryLines.venue.id\": true,\n\t\t\"enquiryLines.status\": true,\n\t\t\"enquiryLines.price\": true,\n\t\t\"enquiryLines.commission\": true,\n\t\t\"enquiryLines.dateTimes\": true\n\t}\n}"},"url":{"raw":"/api/v1/GetEnquiry/:enquiryId","path":["api","v1","GetEnquiry",":enquiryId"],"variable":[{"key":"enquiryId","value":"ihHep6s2f5SMozHYa","description":"The Enquiry Id of the enquiry to get"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"enquiry\": {\n\t\t\"enquiryId\": \"ihHep6s2f5SMozHYa\",\n\t\t\"status\": {\n\t\t\t\"value\": \"won\"\n\t\t},\n\t\t\"description\": {\n\t\t\t\"name\": \"Fashion Launch\",\n\t\t\t\"long\": \"We’re trying to find a space we can hire for 2 full days. Can’t be anything too ornate/beautiful. We talking an old warehouse, or industrial space. Has an edge. I would want to get 500 people in it.\"\n\t\t},\n\t\t\"city\": {\n\t\t\t\"id\": 1,\n\t\t\t\"name\": \"London\"\n\t\t},\n\t\t\"budget\": {\n\t\t\t\"currency\": \"GBP\",\n\t\t\t\"value\": 16500,\n\t\t\t\"type\": \"totalEvent\"\n\t\t},\n\t\t\"people\": {\n\t\t\t\"value\": 500,\n\t\t\t\"style\": \"other-standing\"\n\t\t},\n\t\t\"eventDateTimes\": [\n\t\t\t{\n\t\t\t\t\"startDateTime\": \"2019-02-11T09:00:00.000Z\",\n\t\t\t\t\"endDateTime\": \"2019-02-11T23:00:00.000Z\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"startDateTime\": \"2019-02-12T09:00:00.000Z\",\n\t\t\t\t\"endDateTime\": \"2019-02-12T23:00:00.000Z\"\n\t\t\t}\n\t\t],\n\t\t\"dateTimes\": {\n\t\t\t\"created\": \"2018-09-17T10:12:00.000Z\",\n\t\t\t\"updated\": \"2019-04-01T16:40:00.000Z\",\n\t\t\t\"closed\": \"2018-11-17T09:47:00.000Z\"\n\t\t}\t\n\t}, \n\t\"enquiryLines\": [\n\t\t{\n\t\t\t\"enquiryLineId\": \"ssLLNAZ8wccYe7dEi\",\n\t\t\t\"ids\": {\n\t\t\t\t\"usage\": 3372,\n\t\t\t\t\"space\": 3980,\n\t\t\t\t\"venue\": 2738\n\t\t\t},\n\t\t\t\"status\": {\n\t\t\t\t\"value\": \"won\"\n\t\t\t},\n\t\t\t\"price\": {\n\t\t\t\t\"currency\": \"GBP\",\n\t\t\t\t\"value\": 21000,\n\t\t\t\t\"type\": \"final\"\n\t\t\t},\n\t\t\t\"commission\": {\n\t\t\t\t\"fromVenueToHireSpace\": {\n\t\t\t\t\t\"currency\": \"GBP\",\n\t\t\t\t\t\"value\": 2100,\n\t\t\t\t\t\"paid\": true\n\t\t\t\t},\n\t\t\t\t\"fromHireSpaceToPartner\": {\n\t\t\t\t\t\"currency\": \"GBP\",\n\t\t\t\t\t\"value\": 210,\n\t\t\t\t\t\"paid\": true\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"dateTimes\": {\n\t\t\t\t\"created\": \"2018-09-17T08:00:00.000Z\",\n\t\t\t\t\"updated\": \"2019-04-01T16:40:00.000Z\",\n\t\t\t\t\"closed\": \"2018-11-17T09:47:00.000Z\",\n\t\t\t\t\"finalPrice\": \"2019-01-17T13:10:00.000Z\",\n\t\t\t\t\"paidFromVenueToHS\": \"2019-03-19T14:42:00.000Z\",\n\t\t\t\t\"paidFromHireSpaceToPartner\": \"2019-04-01T16:40:00.000Z\"\n\t\t\t}\n\t\t}\n\t]\n}"}],"_postman_id":"230e80e8-5b7f-4211-8ac7-13d68fd9e3a5"},{"name":"Get Usage","id":"2b1203cb-b396-4da1-8214-48d4003ff9b2","request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"projection\": {\n\t\t\"id\": true,\n\t\t\"description\": true,\n\t\t\"summary\": true,\n\t\t\"similarUsages\": true,\n\t\t\"capacities\": true,\n\t\t\"images\": true,\n\t\t\"prices\": true,\n\t\t\"features\": true,\n\t\t\"space.id\": true,\n\t\t\"space.description\": true,\n\t\t\"venue.id\": true,\n\t\t\"venue.description\": true\n\t}\n}"},"url":"/api/v1/GetUsage/:usageId","description":"

This endpoint allows partners to get information related to a specific usage. The response may also include informaiton related to its parent space and venue.

\n

This allows partners to present information (including details, pricing and photos) on a specific usages to their users so that users can enquire at specific venues. Remember, if you want your users to be able to enquire at a specific venue via the Add Enquiry endpoint you need to specify a Usage Id!

\n

Only published usages will be returned. The published status of a usage may change at any time so be careful how you design your app!

\n

Further details of the information you can provide to GetUsage can be found here:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Field *(required)Allowed ValuesDescription
projection
Object		n/aAn object which determines which fields may be returned. Please note that dot notation can be used and that the full set of properties available is shown in the example response of these API docs.
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"cbeeb4b0-df98-49e3-a96f-c3814c8ede07","id":"cbeeb4b0-df98-49e3-a96f-c3814c8ede07","name":"Partners","type":"collection"}},"urlObject":{"path":["api","v1","GetUsage",":usageId"],"query":[],"variable":[{"description":{"content":"

The Usage Id of the usage to get

\n","type":"text/plain"},"type":"any","value":"832","key":"usageId"}]}},"response":[{"id":"b23a9cda-c8cc-4b51-8bb1-851b03941111","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"projection\": {\n\t\t\"id\": true,\n\t\t\"description\": true,\n\t\t\"summary\": true,\n\t\t\"similarUsages\": true,\n\t\t\"capacities\": true,\n\t\t\"images\": true,\n\t\t\"prices\": true,\n\t\t\"features\": true,\n\t\t\"space.id\": true,\n\t\t\"space.description\": true,\n\t\t\"venue.id\": true,\n\t\t\"venue.description\": true\n\t}\n}"},"url":{"raw":"/api/v1/GetUsage/:usageId","path":["api","v1","GetUsage",":usageId"],"variable":[{"description":"The Usage Id of the usage to get","key":"usageId","value":"832"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"id\": 832,\n\t\"description\": {\n\t\t\"name\": \"Events\",\n\t\t\"long\": \"A fantastic, traditional, versitile event space in the heart of the city suitable for a wide range of corporate and personal events including conferences and parties.\"\n\t},\n\t\"summary\": {\n\t\t\"maxCapacity\": {\n\t\t\t\"value\": 200,\n\t\t\t\"style\": \"standing\"\n\t\t},\n\t\t\"bestPrice\": {\n\t\t\t\"currency\": \"GBP\",\n\t\t\t\"price\": 60,\n\t\t\t\"minPrice\": 60,\n\t\t\t\"maxPrice\": null,\n\t\t\t\"priceClassification\": \"priceFrom\",\n\t\t\t\"pricingByDelegateType\": \"perDelegate\",\n\t\t\t\"pricingStructureType\": \"delegatePackage\",\n\t\t\t\"pricingByTimeType\": \"perDay\",\n\t\t\t\"startDateTime\": \"2016-11-29T00:00:00Z\",\n\t\t\t\"endDateTime\": null,\n\t\t\t\"indefinite\": true,\n\t\t\t\"daysOfWeek\": 127,\n\t\t\t\"packageName\": \"Daily Delegate Package\",\n\t\t\t\"packageItems\": [\n\t\t\t\t{\n\t\t\t\t\t\"itemName\": \"3x tea and coffee breaks\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"itemName\": \"AV technician for setup and break down\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"itemName\": \"Pens and notepads provided\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"itemName\": \"Private registration desk\"\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"defaultImages\": {\n\t\t\t\"profile\": \t{\n\t\t\t\t\"path\": \"/spaces/832/image2.jpeg\",\n\t\t\t\t\"height\": 900, \n\t\t\t\t\"width\": 1200,\n\t\t\t\t\"altText\": \"Dressed for a conference\"\n\t\t\t},\n\t\t\t\"listing\": \t{\n\t\t\t\t\"path\": \"/spaces/832/image2.jpeg\",\n\t\t\t\t\"height\": 900, \n\t\t\t\t\"width\": 1200,\n\t\t\t\t\"altText\": \"Dressed for a conference\"\n\t\t\t},\n\t\t\t\"search\": \t{\n\t\t\t\t\"path\": \"/spaces/832/image3.jpeg\",\n\t\t\t\t\"height\": 900, \n\t\t\t\t\"width\": 1200,\n\t\t\t\t\"altText\": \"Dressed for a conference\"\n\t\t\t}\n\t\t}\n\t},\n\t\"similarUsages\": [\n\t\t{\n\t\t\t\"usage\": {\n\t\t\t\t\"id\": 8903,\n\t\t\t\t\"name\": \"Events\"\n\t\t\t},\n\t\t\t\"space\": {\n\t\t\t\t\"id\": 8903,\n\t\t\t\t\"name\": \"The Garden Room\"\n\t\t\t},\n\t\t\t\"venue\": {\n\t\t\t\t\"id\": 938,\n\t\t\t\t\"name\": \"Hampton Court\"\n\t\t\t},\n\t\t\t\"distanceBetween\": {\n\t\t\t\t\"unit\": \"metres\",\n\t\t\t\t\"value\": 5694.45\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"usage\": {\n\t\t\t\t\"id\": 93812,\n\t\t\t\t\"name\": \"Events\"\n\t\t\t},\n\t\t\t\"space\": {\n\t\t\t\t\"id\": 8442,\n\t\t\t\t\"name\": \"The Long Room\"\n\t\t\t},\n\t\t\t\"venue\": {\n\t\t\t\t\"id\": 3500,\n\t\t\t\t\"name\": \"Kensington Palace\"\n\t\t\t},\n\t\t\t\"distanceBetween\": {\n\t\t\t\t\"unit\": \"metres\",\n\t\t\t\t\"value\": 12332.922\n\t\t\t}\n\t\t}\n\t],\n\t\"capacities\": [\n\t\t{\n\t\t\t\"value\": 200,\n\t\t\t\"style\": \"standing\"\n\t\t},\n\t\t{\n\t\t\t\"value\": 60,\n\t\t\t\"style\": \"cabaret\"\n\t\t},\n\t\t{\n\t\t\t\"value\": 150,\n\t\t\t\"style\": \"theatre\"\n\t\t}\n\t],\n\t\"images\": [\n\t\t{\n\t\t\t\"path\": \"/spaces/832/image1.jpeg\",\n\t\t\t\"order\": 1,\n\t\t\t\"height\": 700, \n\t\t\t\"width\": 1000,\n\t\t\t\"altText\": \"Entrance\"\n\t\t},\n\t\t{\n\t\t\t\"path\": \"/spaces/832/image2.jpeg\",\n\t\t\t\"order\": 0,\n\t\t\t\"height\": 900, \n\t\t\t\"width\": 1200,\n\t\t\t\"altText\": \"Dressed for a conference\"\n\t\t},\n\t\t\t\t{\n\t\t\t\"path\": \"/spaces/832/image3.jpeg\",\n\t\t\t\"order\": 2,\n\t\t\t\"height\": 400, \n\t\t\t\"width\": 400,\n\t\t\t\"altText\": \"When the queen visited\"\n\t\t}\n\t],\n\t\"prices\": [\n\t\t{\n\t\t\t\"currency\": \"GBP\",\n\t\t\t\"price\": 60,\n\t\t\t\"minPrice\": 60,\n\t\t\t\"maxPrice\": null,\n\t\t\t\"priceClassification\": \"priceFrom\",\n\t\t\t\"pricingByDelegateType\": \"perDelegate\",\n\t\t\t\"pricingStructureType\": \"delegatePackage\",\n\t\t\t\"pricingByTimeType\": \"perDay\",\n\t\t\t\"startDateTime\": \"2016-01-01T00:00:00Z\",\n\t\t\t\"endDateTime\": null,\n\t\t\t\"indefinite\": true,\n\t\t\t\"daysOfWeek\": 127,\n\t\t\t\"packageName\": \"Daily Delegate Package\",\n\t\t\t\"packageItems\": [\n\t\t\t\t{\n\t\t\t\t\t\"itemName\": \"3x tea and coffee breaks\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"itemName\": \"AV technician for setup and break down\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"itemName\": \"Pens and notepads provided\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"itemName\": \"Private registration desk\"\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"currency\": \"GBP\",\n\t\t\t\"price\": 8000,\n\t\t\t\"minPrice\": 8000,\n\t\t\t\"maxPrice\": null,\n\t\t\t\"priceClassification\": \"fixedPrice\",\n\t\t\t\"pricingByDelegateType\": \"perTime\",\n\t\t\t\"pricingStructureType\": \"venueFee\",\n\t\t\t\"pricingByTimeType\": \"perDay\",\n\t\t\t\"startDateTime\": \"2016-01-01T00:00:00Z\",\n\t\t\t\"endDateTime\": null,\n\t\t\t\"indefinite\": true,\n\t\t\t\"daysOfWeek\": 127\n\t\t}\n\t],\n\t\"features\": [\n\t\t{\n\t\t\t\"value\": \"Kitchen Space\"\n\t\t},\n\t\t\t\t{\n\t\t\t\"value\": \"Laptop/Mac\"\n\t\t},\n\t\t\t\t{\n\t\t\t\"value\": \"Technician\"\n\t\t},\n\t\t{\n\t\t\t\"value\": \"Natural Light\"\n\t\t}\n\t],\n\t\"space\": {\n\t\t\"id\": 837,\n\t\t\"description\": {\n\t\t\t\"name\": \"The Ballroom\"\t\n\t\t}\n\t},\n\t\"venue\": {\n\t\t\"id\": 9823,\n\t\t\"description\": {\n\t\t\t\"name\": \"The Royal Palace\",\n\t\t\t\"long\": \"The Royal Palace is a deeply historic venue made up for the purposes of API documnetation. Steeped in history from through the ages, it is a tradition venue with a stories of kings, queens, scandle and adventure.\"\t\n\t\t}\n\t}\n}"}],"_postman_id":"2b1203cb-b396-4da1-8214-48d4003ff9b2"},{"name":"Get Space","id":"6d6a2795-761d-4aab-bac2-fd9078409976","request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"projection\": {\n\t\t\"id\": true,\n\t\t\"description\": true,\n\t\t\"dimensions\": true,\n\t\t\"extraSpace\": true,\n\t\t\"disabledAccess\": true,\n\t\t\"freeWifi\": true,\n\t\t\"licences\": true,\n\t\t\"additionalCharges\": true,\n\t\t\"strictness\": true,\n\t\t\"venue.id\": true,\n\t\t\"venue.name\": true,\n\t\t\"venue.description\": true\n\t}\n}"},"url":"/api/v1/GetSpace/:spaceId","description":"

This endpoint allows partners to get information related to a specific space. The response may also include informaiton related to its parent venue.

\n

If a partner is presenting information they are advised to present usages, rather than spaces, as information such as photos and pricing is store at a usage level.

\n

Only published spaces will be returned. The published status of a space may change at any time so be careful how you design your app!

\n

\"completelyFlexible\", \"someNegotiation\", \"noNegotiation\"

\n

Further details of the information you can provide to GetSpace can be found here:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Field *(required)Allowed ValuesDescription
projection
Object		n/aAn object which determines which fields may be returned. Please note that dot notation can be used and that the full set of properties available is shown in the example response of these API docs.
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"cbeeb4b0-df98-49e3-a96f-c3814c8ede07","id":"cbeeb4b0-df98-49e3-a96f-c3814c8ede07","name":"Partners","type":"collection"}},"urlObject":{"path":["api","v1","GetSpace",":spaceId"],"query":[],"variable":[{"type":"any","value":"832","key":"spaceId"}]}},"response":[{"id":"00ba8f40-ae40-4575-a649-ac08e5fa720b","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"projection\": {\n\t\t\"id\": true,\n\t\t\"description\": true,\n\t\t\"dimensions\": true,\n\t\t\"extraSpace\": true,\n\t\t\"disabledAccess\": true,\n\t\t\"freeWifi\": true,\n\t\t\"licences\": true,\n\t\t\"additionalCharges\": true,\n\t\t\"strictness\": true,\n\t\t\"venue.id\": true,\n\t\t\"venue.name\": true,\n\t\t\"venue.description\": true\n\t}\n}"},"url":{"raw":"/api/v1/GetSpace/:spaceId","path":["api","v1","GetSpace",":spaceId"],"variable":[{"key":"spaceId","value":"832"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"id\": 837,\n\t\"description\": {\n\t\t\"name\": \"The Ballroom\"\t\n\t},\n\t\"dimensions\": {\n\t \"areaSquareMetres\": 120,\n\t \"heightMetres\": 3\n\t},\n\t\"extraSpace\": {\n\t \"storage\": false,\n\t \"outdoor\": false\n\t},\n\t\"disabledAccess\": true,\n\t\"freeWifi\": true,\n\t\"licences\": {\n\t \"hasWeddingLicence\": true,\n\t \"timeLicencedUntil\": \"11:00PM\",\n\t \"licenceExtensionsAvailable\": true,\n\t \"extensionAvailableUntil\": \"1:00AM\",\n\t \"temporaryEntertainmentNoticesAvailable\": true\n\t},\n\t\"additionalCharges\": {\n\t \"hasAdditionalCharges\": true,\n\t \"description\": \"A 10% service charge may apply to your booking\"\n\t},\n\t\"strictness\": {\n\t \"prices\": \"someNegotiation\",\n\t \"times\": \"noNegotiation\"\n\t},\n\t\"venue\": {\n\t\t\"id\": 9823,\n\t\t\"description\":{\n\t\t\t\"name\": \"The Royal Palace\",\n\t\t\t\"long\": \"The Royal Palace is a deeply historic venue made up for the purposes of API documnetation. Steeped in history from through the ages, it is a tradition venue with a stories of kings, queens, scandle and adventure.\"\n\t\t}\n\t}\n}"}],"_postman_id":"6d6a2795-761d-4aab-bac2-fd9078409976"},{"name":"Get Venue","id":"13f78bc7-bf3e-4b98-ab85-99f48dc9cd50","request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"projection\": {\n\t\t\"id\": true,\n\t\t\"description\": true,\n\t\t\"allowedEvents\": true,\n\t\t\"homeTruths\": true,\n\t\t\"externalCatering\": true,\n\t\t\"cateringFacilities\": true,\n\t\t\"internalCatering\": true,\n\t\t\"recommendedSuppliers\": true,\n\t\t\"features\": true,\n\t\t\"parking\": true,\n\t\t\"accomodation\": true,\n\t\t\"location\": true\n\t}\n}"},"url":"/api/v1/GetVenue/:venueId","description":"

This endpoint allows partners to get information related to a specific venue.

\n

If a partner is presenting information they are advised to present usages, rather than venues, as information such as photos and pricing is stored at a usage level.

\n

Only published venues will be returned. The published status of a venue may change at any time so be careful how you design your app!

\n

Further details of the information you can provide to GetVenue can be found here:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Field *(required)Allowed ValuesDescription
projection
Object		n/aAn object which determines which fields may be returned. Please note that dot notation can be used and that the full set of properties available is shown in the example response of these API docs.
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"cbeeb4b0-df98-49e3-a96f-c3814c8ede07","id":"cbeeb4b0-df98-49e3-a96f-c3814c8ede07","name":"Partners","type":"collection"}},"urlObject":{"path":["api","v1","GetVenue",":venueId"],"query":[],"variable":[{"type":"any","value":"6091","key":"venueId"}]}},"response":[{"id":"97959e0f-642c-460c-9f00-308158bb2723","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"projection\": {\n\t\t\"id\": true,\n\t\t\"description\": true,\n\t\t\"allowedEvents\": true,\n\t\t\"homeTruths\": true,\n\t\t\"externalCatering\": true,\n\t\t\"cateringFacilities\": true,\n\t\t\"internalCatering\": true,\n\t\t\"recommendedSuppliers\": true,\n\t\t\"features\": true,\n\t\t\"parking\": true,\n\t\t\"accomodation\": true,\n\t\t\"location\": true\n\t}\n}"},"url":{"raw":"/api/v1/GetVenue/:venueId","path":["api","v1","GetVenue",":venueId"],"variable":[{"key":"venueId","value":"6091"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 9823,\n \"description\": {\n \"name\": \"The Royal Palace\",\n \t\"long\": \"The Royal Palace is a deeply historic venue made up for the purposes of API documnetation. Steeped in history from through the ages, it is a tradition venue with a stories of kings, queens, scandle and adventure.\"\n },\n \"allowedEvents\": {\n \"artExhibitions\": false,\n \"popUps\": false,\n \"promoters\": false,\n \"ticketedEvents\": false,\n \"amplifiedEvents\": false,\n \"ownMusic\": true,\n \"18thBirthday\": true,\n \"21stBirthday\": true,\n \"weddings\": true,\n \"eventsWithAlcohol\": true\n },\n \"homeTruths\": \"The venue is also a popular tourist attraction so you much expect tourists in communual areas of the venue between the hours of 9-5pm.\",\n \"externalCatering\": {\n \"allowsExternalCatering\": false,\n \"allowsExternalAlcohol\": false,\n \"corkageCharge\": false,\n \"cateringEquipmentCharge\": false,\n \"kitchenBuyOutFee\": false,\n \"allowsExternalOtherSuppliers\": false\n },\n \"cateringFacilities\": {\n \"hasProfessionalKitchen\": true,\n \"hasKitchenette\": false,\n \"hasBar\": false,\n \"hasCateringEquipment\": true,\n \"hasSpaceForExternalCateringEquipment\": false\n },\n \"internalCatering\": {\n \"providesInternalCatering\": true,\n \"halalOptionAvailable\": true,\n \"kosherOptionAvailable\": true,\n \"hasAlcoholLicence\": true\n },\n \"recommendedSuppliers\": {\n \"listType\": \"exclusive\",\n \"list\": [\n {\n \"name\": \"Bovingdons\"\n },\n {\n \"name\": \"CREATE\"\n }\n ]\n },\n \"features\": [\n {\n \"name\": \"On site event manager\"\n },\n {\n \"name\": \"Super-speed wifi throughout\"\n }\n ],\n \"parking\": {\n \"hasParking\": true,\n \"numberOfSpaces\": 50\n },\n \"accomodation\": {\n \"hasAccomodation\": true,\n \"numberOfRooms\": 12\n },\n \"location\": {\n \"address\": {\n \"line1\": \"Palace Gardens\",\n \"line2\": \"Palace Street\",\n \"neighbourhood\": \"Westminster\",\n \"city\": \"London\",\n \"county\": \"Greater London\",\n \"country\": \"Great Britain\",\n \"postcode\": \"SW1A 1AA\"\n },\n \"city\": {\n \"id\": 1,\n \"name\": \"London\"\n },\n \"country\": {\n \"iso3166Code\": \"GBR\",\n \"name\": \"Great Britain\"\n },\n \"longitude\": -0.300655,\n \"latitude\": 51.464125,\n \"nearestTransport\": \"Victoria Station\"\n }\n}"}],"_postman_id":"13f78bc7-bf3e-4b98-ab85-99f48dc9cd50"},{"name":"Get Usages","id":"61f11dab-50b5-4f52-9d96-c0e961779307","request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"match\": {\n\t\t\"venue.location.city.id\": 1\t\n\t},\n\t\"orderBy\": {\n\t\t\"summary.maxCapacity\": -1\n\t},\n\t\"limit\": 5,\n\t\"skip\": 0,\n\t\"projection\": {\n\t\t\"id\": true,\n\t\t\"description.name\": true,\n\t\t\"venue.id\": true,\n\t\t\"venue.description.name\": true\n\t}\n}"},"url":"/api/v1/GetUsages","description":"

This endpoint allows partners to get information related to a group of usages. The response may also include informaiton related to its parent space and venue.

\n

You can add OData queries to filter the information by any field, sort the data, skip, top and do much more. You can view a detailed document of how to do this here: https://msdn.microsoft.com/en-gb/library/gg309461.aspx

\n

There are tens of thousands of usages which are updated regularly and so we do not recommend that partners retain their own copy of this information set.

\n

Maximim number of usages which can be returned in a single call is 20 and if you require more usages for your use case you can page through the data set.

\n

Further details of the information you can provide to GetUsages can be found here:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Field *(required)Allowed ValuesDescription
match
Object		n/aA query object which will filter the records returned. It takes a MongoDB like syntax.
orderBy
Object		n/aAn object which determins the direction which documents are sorted in. It takes a syntax similar to the MongoDB .sort function.
limit
Object		n/aThe maximum number of records to be returned.
skip
Object		n/aThe number of records to skip before returning the results.
projection
Object		n/aAn object which determines which fields may be returned. Please note that dot notation can be used and that the full set of properties available is shown in the example response of these API docs.
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"cbeeb4b0-df98-49e3-a96f-c3814c8ede07","id":"cbeeb4b0-df98-49e3-a96f-c3814c8ede07","name":"Partners","type":"collection"}},"urlObject":{"path":["api","v1","GetUsages"],"query":[],"variable":[]}},"response":[{"id":"b888482d-5b96-403c-a77a-301bed08aed9","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"match\": {\n\t\t\"venue.location.city.id\": 1\t\n\t},\n\t\"orderBy\": {\n\t\t\"summary.maxCapacity\": -1\n\t},\n\t\"limit\": 5,\n\t\"skip\": 0,\n\t\"projection\": {\n\t\t\"id\": true,\n\t\t\"name\": true,\n\t\t\"venue.id\": true,\n\t\t\"venue.name\": true\n\t}\n}"},"url":"/api/v1/GetUsages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \t\"id\": 132153,\n \"description\": {\n \t\"name\": \"Business\"\n },\n \"venue\": {\n \t\"id\": 74835,\n \t\"description\": {\n \t\t\"name\": \"The O2\"\n \t}\n }\n },\n {\n \t\"id\": 132154,\n \"description\": {\n \t\"name\": \"Events\"\n },\n \"venue\": {\n \t\"id\": 74835,\n \t\"description\": {\n \t\t\"name\": \"The O2\"\n \t}\n }\n },\n {\n \t\"id\": 167944,\n \"description\": {\n \t\"name\": \"Events\"\n },\n \"venue\": {\n \t\"id\": 78545,\n \t\"description\": {\n \t\t\"name\": \"The SSE Arena, Wembley\"\n \t}\n }\n },\n {\n \t\"id\": 167942,\n \"description\": {\n \t\"name\": \"Business\"\n },\n \"venue\": {\n \t\"id\": 78545,\n \t\"description\": {\n \t\t\"name\": \"The SSE Arena, Wembley\"\n \t}\n }\n },\n {\n \t\"id\": 128263,\n \"description\": {\n \t\"name\": \"Business\"\n },\n \"venue\": {\n \t\"id\": 78545,\n \t\"description\": {\n \t\t\"name\": \"Alexandra Palace\"\n \t}\n }\n }\n]"}],"_postman_id":"61f11dab-50b5-4f52-9d96-c0e961779307"},{"name":"Get Spaces","id":"74221614-dec1-4cf2-b6b2-78757eb011d8","request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"match\": {\n\t\t\"venue.location.city.id\": 1\t\n\t},\n\t\"orderBy\": {\n\t\t\"dimensions.areaSquareMetres\": -1\n\t},\n\t\"limit\": 5,\n\t\"skip\": 0,\n\t\"projection\": {\n\t\t\"id\": true,\n\t\t\"description.name\": true,\n\t\t\"venue.id\": true,\n\t\t\"venue.description.name\": true\n\t}\n}"},"url":"/api/v1/GetSpaces","description":"

This endpoint allows partners to get information related to a group of spaces. The response may also include informaiton related to its parent venue.

\n

You can add OData queries to filter the information by any field, sort the data, skip, top and do much more. You can view a detailed document of how to do this here: https://msdn.microsoft.com/en-gb/library/gg309461.aspx

\n

There are tens of thousands of spaces which are updated regularly and so we do not recommend that partners retain their own copy of this information set.

\n

Maximim number of usages which can be returned in a single call is 20 and if you require more spaces for your use case you can page through the data set.

\n

Further details of the information you can provide to GetSpaces can be found here:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Field *(required)Allowed ValuesDescription
match
Object		n/aA query object which will filter the records returned. It takes a MongoDB like syntax.
orderBy
Object		n/aAn object which determins the direction which documents are sorted in. It takes a syntax similar to the MongoDB .sort function.
limit
Object		n/aThe maximum number of records to be returned.
skip
Object		n/aThe number of records to skip before returning the results.
projection
Object		n/aAn object which determines which fields may be returned. Please note that dot notation can be used and that the full set of properties available is shown in the example response of these API docs.
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"cbeeb4b0-df98-49e3-a96f-c3814c8ede07","id":"cbeeb4b0-df98-49e3-a96f-c3814c8ede07","name":"Partners","type":"collection"}},"urlObject":{"path":["api","v1","GetSpaces"],"query":[],"variable":[]}},"response":[{"id":"08304b9a-0c03-47fa-a6d9-c8f9e3e3e00c","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"match\": {\n\t\t\"venue.location.city.id\": 1\t\n\t},\n\t\"orderBy\": {\n\t\t\"dimensions.areaSquareMetres\": -1\n\t},\n\t\"limit\": 5,\n\t\"skip\": 0,\n\t\"projection\": {\n\t\t\"id\": true,\n\t\t\"name\": true,\n\t\t\"venue.id\": true,\n\t\t\"venue.name\": true\n\t}\n}"},"url":"/api/v1/GetSpaces"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \t\"id\": 100112,\n \t\"description\": {\n\t\t\t\"name\": \"The Yard\"\n \t},\n \"venue\": {\n \t\"id\": 33106,\n \t\t\"description\": {\n \t\t\"name\": \"Printworks London\"\n \t\t}\n }\n },\n {\n \t\"id\": 130652,\n \t\"description\": {\n \t\"name\": \"Summer Parties\"\n \t},\n \"venue\": {\n \t\"id\": 33092,\n \t\t\"description\": {\n \t\t\"name\": \"The Hurlingham Club\"\n \t\t}\n }\n },\n {\n \t\"id\": 154538,\n \t\"description\": {\n \t\"name\": \"Whole Venue\"\n \t},\n \"venue\": {\n \t\"id\": 75844,\n \t\t\"description\": {\n \t\t\"name\": \"O2 Academy Brixton\"\n \t\t}\n }\n },\n {\n \t\"id\": 100110,\n \t\"description\": {\n \t\"name\": \"The Press Halls\"\n \t},\n \"venue\": {\n \t\"id\": 33106,\n \t\t\"description\": {\n \t\t\"name\": \"Printworks London\"\n \t\t}\n }\n },\n {\n \t\"id\": 4827,\n \t\"description\": {\n \t\"name\": \"One Tunnel\"\n \t},\n \"venue\": {\n \t\"id\": 1441,\n \t\t\"description\": {\n \t\t\"name\": \"The Vaults\"\n \t\t}\n }\n }\n]"}],"_postman_id":"74221614-dec1-4cf2-b6b2-78757eb011d8"},{"name":"Get Venues","id":"c556dc2a-b4bb-44f1-8d18-fbcf6cac4046","request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"match\": {\n\t\t\"location.city.id\": 1\t\n\t},\n\t\"orderBy\": {\n\t\t\"parking.numberOfSpaces\": -1\n\t},\n\t\"limit\": 5,\n\t\"skip\": 0,\n\t\"projection\": {\n\t\t\"id\": true,\n\t\t\"description.name\": true\n\t}\n}"},"url":"/api/v1/GetVenues","description":"

This endpoint allows partners to get information related to a group of venues.

\n

You can add OData queries to filter the information by any field, sort the data, skip, top and do much more. You can view a detailed document of how to do this here: https://msdn.microsoft.com/en-gb/library/gg309461.aspx

\n

There are many thousand venues which are updated regularly and so we do not recommend that partners retain their own copy of this information set.

\n

Maximim number of usages which can be returned in a single call is 20 and if you require more venues for your use case you can page through the data set.

\n

Further details of the information you can provide to GetVenues can be found here:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Field *(required)Allowed ValuesDescription
match
Object		n/aA query object which will filter the records returned. It takes a MongoDB like syntax.
orderBy
Object		n/aAn object which determins the direction which documents are sorted in. It takes a syntax similar to the MongoDB .sort function.
limit
Object		n/aThe maximum number of records to be returned.
skip
Object		n/aThe number of records to skip before returning the results.
projection
Object		n/aAn object which determines which fields may be returned. Please note that dot notation can be used and that the full set of properties available is shown in the example response of these API docs.
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"cbeeb4b0-df98-49e3-a96f-c3814c8ede07","id":"cbeeb4b0-df98-49e3-a96f-c3814c8ede07","name":"Partners","type":"collection"}},"urlObject":{"path":["api","v1","GetVenues"],"query":[],"variable":[]}},"response":[{"id":"dbe1d9d2-1d33-4c70-9181-c20167a7cc81","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"match\": {\n\t\t\"location.city.id\": 1\t\n\t},\n\t\"orderBy\": {\n\t\t\"parking.numberOfSpaces\": -1\n\t},\n\t\"limit\": 5,\n\t\"skip\": 0,\n\t\"projection\": {\n\t\t\"id\": true,\n\t\t\"name\": true\n\t}\n}"},"url":"/api/v1/GetVenues"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n\t{\n\t \"id\": 2727,\n \"description\": {\n\t \t\"name\": \"ExCeL London\"\n }\n\t},\n\t{\n\t \"id\": 78756,\n \"description\": {\n\t \t\"name\": \"All Star Lanes - White City\"\n }\n\t},\n\t{\n\t \"id\": 163,\n \"description\": {\n\t \t\"name\": \"The Chelsea Harbour Hotel\"\n }\n\t},\n\t{\n\t \"id\": 79473,\n \"description\": {\n\t \t\"name\": \"Cineworld - The O2 Greenwich\"\n }\n\t},\n\t{\n\t \"id\": 73999,\n \"description\": {\n\t \t\"name\": \"Twickenham Stadium\"\n }\n\t}\n]"}],"_postman_id":"c556dc2a-b4bb-44f1-8d18-fbcf6cac4046"},{"name":"Search","id":"b2d54d46-e099-40d2-89c4-2ff40883e08e","request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"query\": {\n\t \"city\": {\n\t \t\"id\": 1\n\t },\n\t \"searchTerm\": \"conference\",\n\t\t\"disabledAccess\": true,\n\t\t\"freeWifi\": true,\n\t \"budget\": {\n\t \t\"min\": 100,\n\t \t\"max\": 20000\n\t },\n\t \"people\": {\n\t \t\"value\": 100,\n\t \t\"style\": \"dining\"\n\t },\n\t \"location\": {\n\t \"longitude\": -0.300655,\n\t \"latitude\": 51.464125,\n\t \t\"radius\": {\n\t \t\t\"unit\": \"miles\",\n\t \t\t\"value\": 5\t\n\t \t}\n\t },\n\t \"externalCatering\": {\n\t \"allowsExternalCatering\": false,\n\t \"allowsExternalAlcohol\": false,\n\t \"corkageCharge\": false\n\t },\n\t \"cateringFacilities\": {\n\t \"hasProfessionalKitchen\": true,\n\t \"hasKitchenette\": false,\n\t \"hasCateringEquipment\": true,\n\t \"hasSpaceForExternalCateringEquipment\": false\n\t },\n\t \"internalCatering\": {\n\t \"providesInternalCatering\": true,\n\t \"halalOptionAvailable\": true,\n\t \"kosherOptionAvailable\": true\n\t },\n\t \"parking\": {\n\t \"hasParking\": true,\n\t \"numberOfSpaces\": 50\n\t },\n\t \"accomodation\": {\n\t \"hasAccomodation\": true,\n\t \"numberOfRooms\": 12\n\t },\n\t\t\"dimensions\": {\n\t\t \"area\": {\n\t\t \t\"unit\": \"metres\",\n\t\t \t\"value\": 120\n\t\t },\n\t\t \"height\": {\n\t\t \t\"unit\": \"metres\",\n\t\t \t\"value\": 3\n\t\t }\n\t\t},\n\t\t\"extraSpace\": {\n\t\t \"storage\": false,\n\t\t \"outdoor\": false\n\t\t},\n\t\t\"licences\": {\n\t \"hasAlcoholLicence\": true,\n\t\t \"hasWeddingLicence\": true\n\t\t}\n\t},\n\t\"projection\": {\n\t\t\"id\": true,\n\t\t\"name\": true,\n\t\t\"venue.id\": true,\n\t\t\"venue.name\": true\n\t}\n}"},"url":"/api/v1/Search","description":"

This endpoint allows partners to search our database to return relevant usages/spaces/venues to users.

\n

This endpoint is favoured as a method to display relevent venue content users as it is more performant than the Get Usages endpoint. It also contains more sophisticated ranking logic which makes it more like to present the best venues.

\n

A single search query will return a maximum of 300 venues, even if there are more than 300 venues which satisfy the search query in the Hire Space database.

\n

A maximum of one usage (the most relevent) from each venue will be returned.

\n

Search has many available filters, although none are required.

\n

Further details of the information you can provide to Search can be found here:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Field *(required)Allowed ValuesDescription
query.city.id
Integer		n/aThe code of the city the enquiry relates to. This is a strict filter.
searchTerm
String		n/aThe type of event, or other venue relate keyword(s), which will be matched to the venues returned.
disabledAccess
Boolean		n/aA Boolean value which indicates if the venues returned will have full disabled access or not.
freeWifi
Boolean		n/aA Boolean value which indicates if the venues returned will have free wifi.
budget.min
Integer		n/aOnly venues with a price greater than the minimum budget will be included in the results. Where pricing is person, it will be caculated using 75% of the maximum capacity.
budget.max
Integer		n/aOnly venues with a price less than the maximum budget will be included in the results. Where pricing is person, it will be caculated using 75% of the maximum capacity.
location.longitude
Double		n/aThe latutude to centre the results on.
location.latitude
Double		n/aThe latutude to centre the results on.
location.radius.unit
String		miles, kmThe unit of the radius.
location.radius.value
Double		n/aVenues within the circle centered at the latitude/latitude and with the given radius will be prioritised within the results. This is a not a strict filter.
externalCatering.allowsExternalCatering
Boolean		n/aA Boolean value which indicates if the venues returned will have free wifi.
externalCatering.allowsExternalAlcoholFree
Boolean		n/aA Boolean value which indicates if the venues returned will allow external alcohol to be brought, free of charge, to the venue.
externalCatering.corkageCharge
Boolean		n/aA Boolean value which indicates if the venues returned will charge allow external alcohol with a corkage charge.
cateringFacilities.hasProfessionalKitchen
Boolean		n/aA Boolean value which indicates if the venues returned will have a professional kitchen.
cateringFacilities.hasKitchenette
Boolean		n/aA Boolean value which indicates if the venues returned will have a kitchenette.
cateringFacilities.hasCateringEquipment
Boolean		n/aA Boolean value which indicates if the venues returned will have catering equipment.
cateringFacilities.hasSpaceForExternalCateringEquipment
Boolean		n/aA Boolean value which indicates if the venues returned will have space for an external provider to bring catering equipment.
internalCatering.providesInternalCatering
Boolean		n/aA Boolean value which indicates if the venues returned can provide catering.
internalCatering.halalOptionAvailable
Boolean		n/aA Boolean value which indicates if the venues returned can provide halal catering.
internalCatering.kosherOptionAvailable
Boolean		n/aA Boolean value which indicates if the venues returned can provide kosher catering.
parking.hasParking
Boolean		n/aA Boolean value which indicates if the venues returned have car parking spaces available.
parking.numberOfSpaces
Integer		n/aOnly venues with at least this number of parking spaces will be included in the results.
accomodation.hasAccomodation
Boolean		n/aA Boolean value which indicates if the venues returned have accomodation available.
accomodation.numberOfRooms
Integer		n/aOnly venues with at least this number of on-site hotel rooms will be included in the results.
dimensions.area.unit
String		squareMetres, squareFeetThe unit of the minimum area for the spaces returned.
dimensions.area.value
Double		n/aOnly spaces with at least this area will be included in the results.
dimensions.height.unit
String		metres, feet.
dimensions.height.value
Double		n/aOnly venues with at least this number of on-site hotel rooms will be included in the results.
extraSpace.storage
Boolean		n/aOnly venues which have extra storage space outside the main space will be included in the results.
extraSpace.outdoor
Boolean		n/aOnly venues which have outdoor space will be included in the results.
licences.hasAlcoholLicence
Boolean		n/aOnly venues which have a licence to sell alcohol will be included in the results.
licences.hasWeddingLicence
Boolean		n/aOnly venues which have a wedding licence will be included in the results.
projection
Object		n/aAn object which determines which fields may be returned. Please note that dot notation can be used and that the full set of properties available is shown in the example response of these API docs.
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"cbeeb4b0-df98-49e3-a96f-c3814c8ede07","id":"cbeeb4b0-df98-49e3-a96f-c3814c8ede07","name":"Partners","type":"collection"}},"urlObject":{"path":["api","v1","Search"],"query":[],"variable":[]}},"response":[{"id":"91a634dc-e998-4c6b-b4a6-998403dfdef0","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"query\": {\n\t \"city\": {\n\t \t\"id\": 1\n\t },\n\t \"searchTerm\": \"conference\",\n\t\t\"disabledAccess\": true,\n\t\t\"freeWifi\": true,\n\t \"budget\": {\n\t \t\"min\": 100,\n\t \t\"max\": 20000\n\t },\n\t \"people\": {\n\t \t\"value\": 100,\n\t \t\"style\": \"dining\"\n\t },\n\t \"location\": {\n\t \"longitude\": -0.300655,\n\t \"latitude\": 51.464125,\n\t \t\"radius\": {\n\t \t\t\"unit\": \"miles\",\n\t \t\t\"value\": 5\t\n\t \t}\n\t },\n\t \"externalCatering\": {\n\t \"allowsExternalCatering\": false,\n\t \"allowsExternalAlcohol\": false,\n\t \"corkageCharge\": false\n\t },\n\t \"cateringFacilities\": {\n\t \"hasProfessionalKitchen\": true,\n\t \"hasKitchenette\": false,\n\t \"hasCateringEquipment\": true,\n\t \"hasSpaceForExternalCateringEquipment\": false\n\t },\n\t \"internalCatering\": {\n\t \"providesInternalCatering\": true,\n\t \"halalOptionAvailable\": true,\n\t \"kosherOptionAvailable\": true\n\t },\n\t \"parking\": {\n\t \"hasParking\": true,\n\t \"numberOfSpaces\": 50\n\t },\n\t \"accomodation\": {\n\t \"hasAccomodation\": true,\n\t \"numberOfRooms\": 12\n\t },\n\t\t\"dimensions\": {\n\t\t \"area\": {\n\t\t \t\"unit\": \"metres\",\n\t\t \t\"value\": 120\n\t\t },\n\t\t \"height\": {\n\t\t \t\"unit\": \"metres\",\n\t\t \t\"value\": 3\n\t\t }\n\t\t},\n\t\t\"extraSpace\": {\n\t\t \"storage\": false,\n\t\t \"outdoor\": false\n\t\t},\n\t\t\"licences\": {\n\t \"hasAlcoholLicence\": true,\n\t\t \"hasWeddingLicence\": true\n\t\t}\n\t},\n\t\"projection\": {\n\t\t\"id\": true,\n\t\t\"name\": true,\n\t\t\"venue.id\": true,\n\t\t\"venue.name\": true\n\t}\n}"},"url":"/api/v1/Search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 132153,\n \"name\": \"Business\",\n \"space\": {\n \"id\": 2334,\n \"name\": \"The White Studio\"\n },\n \"venue\": {\n \"id\": 578,\n \"name\": \"Studio Spaces E2\"\n }\n },\n {\n \"id\": 132154,\n \"name\": \"Business\",\n \"space\": {\n \"id\": 231,\n \"name\": \"Whole Venue\"\n },\n \"venue\": {\n \"id\": 92382,\n \"name\": \"Oval Space\"\n }\n },\n {\n \"id\": 167944,\n \"name\": \"Events\",\n \t\"space\": {\n \"id\": 2313,\n \"name\": \"F Block T3\"\n },\n \"venue\": {\n \"id\": 9128,\n \"name\": \"The Old Truman Brewery\"\n }\n },\n {\n \"id\": 167942,\n \"name\": \"Business\",\n \t\"space\": {\n \"id\": 93493,\n \"name\": \"Whole Venue\"\n },\n \"venue\": {\n \"id\": 232,\n \"name\": \"The Pickle Factory\"\n }\n }\n]"}],"_postman_id":"b2d54d46-e099-40d2-89c4-2ff40883e08e"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"799e2d7f-11b8-45b7-bd51-5bc02858a49a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eff0585f-4790-45f1-a9a4-e4f1bfab3c96","type":"text/javascript","exec":[""]}}],"variable":[{"key":"url","value":"https://partners.hirespace.com/Api/v1/"}]}