Search K

Appearance

Get reservations ​

GET
/v1/reservations
Server

Gets a list with reservations made with this specific client/distributor id

Authorizations​

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

Parameters​

Query Parameters

sorting
Typestring
default
page_size

Number of items per page

Typeinteger
default50
page

Current page

Typeinteger
default1
created

Filter reservation on their creation date

Typestring
valid_until

Filter reservation on their valid until date

Typestring
status

Enum: active, booked, void, error, extended

Typestring
query

query

Typestring
event_id

Filter reservation on their event ID

Typestring
distributor_id

Filter reservation on their distributor id

Typestring
on_behalf

Filter reservations on booked on behalf

Typeboolean
ticket_id

Find reservations with ticket id

Typestring

Responses​

OK
application/json
JSON
{
"reservations": [
{
"client_id": "34e7303056c84c74abe9d48a5fbf68aa_cln",
"reservation_id": "64dab4ad7b7a442389a71bc253de0a09_rsv",
"status": "active",
"notify_client": true,
"notes": "Example note.",
"valid_until": "2024-05-01T12:30:32",
"created": "2024-05-01T12:20:32",
"updated": "2024-05-01T12:20:32",
"parent_allocation_id": "string",
"items": [
{
"currency": "EUR",
"event_name": "4th Round (Men's & Ladies) - Centre Court - Day 8 - Wimbledon (2024)",
"net_rate": 340000,
"quantity": 10,
"salesprice": 340000,
"ticket_id": "b30c5d2d019e4eeba8de2bdd96e93434_tck",
"ticket_name": "Debenture seat"
}
]
}
],
"pagination": {
"total_size": 1,
"page_size": 50,
"next_page": "string",
"previous_page": "string"
}
}

Samples​

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

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
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'

headers = {
    'Content-Type': 'application/json'
}

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