Search K

Appearance

Get reservation guestdata ​

GET
/v1/reservations/{reservation_id}/guestdata
Server

Get the current guest data for the reservation and what is the conditions are.

Authorizations​

api_key
TypeAPI Key (header: X-Api-Key)

Parameters​

Path Parameters

reservation_id*

XS2event ID of the Reservation

Typestring
Required

Query Parameters

sorting
Typestring
default
include_conditions

Include validation conditions?

Typeboolean
Examplefalse
defaultfalse
country_hint

Hint for country code

Typestring
ExampleNLD

Responses​

OK
application/json
JSON
{
"items": [
{
"ticket_id": "ac8e9e918b4b4756b0f32e583a9cb3e4_tck",
"quantity": 4,
"guests": [
{
"contact_email": {
"condition": null,
"error": null,
"value": "support@xs2event.com"
},
"country_of_residence": {
"condition": "pre_checkout",
"error": null,
"value": "NLD"
},
"date_of_birth": {
"condition": "pre_checkout",
"error": null,
"value": "1980-01-01"
},
"first_name": {
"condition": "pre_checkout",
"error": null,
"value": "First"
},
"gender": {
"condition": "pre_checkout",
"error": null,
"value": "male"
},
"guest_id": "5661e8fd160a48e18ec363cad686ba2c_gst",
"last_name": {
"condition": "pre_checkout",
"error": null,
"value": "Tester"
},
"lead_guest": true
},
{
"contact_email": {
"condition": null,
"error": null,
"value": "support@xs2event.com"
},
"country_of_residence": {
"condition": "pre_checkout",
"error": null,
"value": "NLD"
},
"date_of_birth": {
"condition": "pre_checkout",
"error": null,
"value": "1980-01-02"
},
"first_name": {
"condition": "pre_checkout",
"error": null,
"value": "Second"
},
"gender": {
"condition": "pre_checkout",
"error": null,
"value": "female"
},
"guest_id": "808f1076ee01410882ed625abc26b907_gst",
"last_name": {
"condition": "pre_checkout",
"error": null,
"value": "Tester"
},
"lead_guest": false
},
{
"additional_street_name": null,
"city": null,
"contact_email": null,
"contact_phone": null,
"country_of_residence": null,
"date_of_birth": null,
"first_name": {
"condition": null,
"error": null,
"value": null
},
"gender": null,
"guest_id": null,
"last_name": {
"condition": null,
"error": null,
"value": null
},
"lead_guest": null,
"passport_number": null,
"province": null,
"street_name": null,
"zip": null
}
]
}
]
}

Samples​

cURL
curl -X GET \
'https://api.xs2event.com/v1/reservations/{reservation_id}/guestdata?include_conditions=false&country_hint=NLD' \
 -H "Content-Type: application/json"
JavaScript
fetch('https://api.xs2event.com/v1/reservations/{reservation_id}/guestdata?include_conditions=false&country_hint=NLD', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));
PHP
<?php
$url = 'https://api.xs2event.com/v1/reservations/{reservation_id}/guestdata';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];
$query = http_build_query([
    'include_conditions' => 'false',
    'country_hint' => 'NLD',
]);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . '?' . $query);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>
Python
import requests

url = 'https://api.xs2event.com/v1/reservations/{reservation_id}/guestdata'
params = {
    'include_conditions': false,
    'country_hint': 'NLD'
}
headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, params=params, headers=headers)
print(response.json())