List Bookings by External Reference
GET
/bookings
Lists bookings that contain either the extReferenceId and/or extReferenceNumber. Used for searching for specific bookings made by external systems.
Authorizations
OAuth2
clientCredentials Flow
Token URL
"https://login.microsoftonline.com/{issuer}/oauth2/v2.0/token"Scopes:
or
X-API-KEY
Is made available as part of the onboading/integration process.
Type
API Key (header: X-API-KEY)
Parameters
Header Parameters
X-API-KEY*
Client-specific key.
Type
Requiredstring
Query Parameters
extReferenceId
Filter by bookings containing this external identification.
Type
string
Example
"fa8aa66d-680c-4da3-9fd1-f31d46fb336c"extReferenceNumber
Filter by bookings containing this external reference.
Type
string
Example
"1262"Responses
Success
application/json
JSON
{
"data": [
{
"id": "20230221081212-2db89a3f-766a-421e-922a-dbb77fe011d3",
"status": "string",
"timeSlotId": "trlY5s1zestnjauIG8YcqMAyIEys7AQimt+n9CKG+67RbWHLHy952+PU5LUDHQWD",
"venueId": 149,
"timeFrom": "2023-01-11T17:00:00Z",
"timeTo": "2023-01-11T19:00:00Z",
"guest": {
"firstName": "John",
"lastName": "Doe",
"phone": "4790090090",
"email": "john@doe.com"
},
"guestCount": 2,
"comment": "We might arrive 10 minutes late.",
"extReferenceId": "6ecfc7e7-7b31-4b4c-97a3-a3888d2ade94",
"extReferenceNumber": "123",
"extProperties": {
"additionalProperties": "string"
},
"scenarioName": "Breakfast",
"noShowFee": {
"amountPreAuthorized": 500,
"amountToCapture": 250
},
"tags": [
"string"
],
"types": [
"string"
]
}
]
}