List bookings

POST

/v1/listBookings

Retrieve a filtered and paginated list of bookings. Supports filtering by user, status (e.g., only paid bookings), product ID (all bookings for a specific trip), date ranges (bookings created within a time period), and host (bookings from specific whitelabel domains). Results can be sorted by creation date in ascending or descending order, and paginated using limit/offset parameters.

Request

Authorization

Body Params application/json

Examples

Responses

🟢200OK

application/json

Successfully retrieved filtered list of bookings

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

cURL

Get all bookings for a userGet only paid bookings for a userGet open (unpaid) bookingsGet all bookings for a specific productGet recent bookings with paginationGet bookings created in a date rangeGet bookings from specific whitelabel host

curl --location 'https://api.ygo.ai/v1/v1/listBookings' \
--header 'Content-Type: application/json' \
--data '{
    "UserID": "user_abc123xyz",
    "FilterByUserID": true
}'

Response Example

200 - List of multiple bookings

{
    "Data": [
        {
            "ID": "X9Y8Z7W6",
            "UserID": "user_abc123xyz",
            "ProductID": 67890,
            "Status": "paid",
            "Details": {
                "Trip": {
                    "ProductID": 67890,
                    "Name": "Gran Hotel Bahía del Duque - 5 Nights + Flights",
                    "Description": "Exclusive 5-star resort in Tenerife with direct flights from London",
                    "StartDate": "2025-12-10",
                    "EndDate": "2025-12-15",
                    "City": "Costa Adeje",
                    "Country": "Spain",
                    "CountryCode": "ES"
                },
                "Items": [
                    {
                        "ID": "item_activity_001",
                        "ProductID": 78901,
                        "Type": "activity",
                        "Name": "Teide National Park Stargazing Tour",
                        "Quantity": 2,
                        "Status": "booked"
                    }
                ],
                "Travellers": [
                    {
                        "FirstName": "John",
                        "LastName": "Smith",
                        "Type": "adult"
                    },
                    {
                        "FirstName": "Sarah",
                        "LastName": "Smith",
                        "Type": "adult"
                    }
                ],
                "FirstName": "John",
                "LastName": "Smith",
                "Email": "john.smith@example.com",
                "TotalPrice": {
                    "Amount": 2845,
                    "Currency": "EUR"
                },
                "Locale": "en",
                "Shop": "ygotrips",
                "Host": "ygo.ai"
            },
            "CreatedAt": "2025-10-14T10:20:00Z",
            "UpdatedAt": "2025-10-16T16:00:00Z"
        },
        {
            "ID": "A1B2C3D4",
            "UserID": "user_abc123xyz",
            "ProductID": 12345,
            "Status": "booked",
            "Details": {
                "Trip": {
                    "ProductID": 12345,
                    "Name": "Hotel Arts Barcelona - 7 Nights",
                    "Description": "Luxurious 5-star beachfront hotel in Barcelona",
                    "StartDate": "2025-11-15",
                    "EndDate": "2025-11-22",
                    "City": "Barcelona",
                    "Country": "Spain",
                    "CountryCode": "ES"
                },
                "Items": [],
                "Travellers": [
                    {
                        "FirstName": "John",
                        "LastName": "Smith",
                        "Type": "adult"
                    }
                ],
                "FirstName": "John",
                "LastName": "Smith",
                "Email": "john.smith@example.com",
                "TotalPrice": {
                    "Amount": 1850,
                    "Currency": "EUR"
                },
                "Locale": "en",
                "Shop": "ygotrips",
                "Host": "ygo.ai"
            },
            "CreatedAt": "2025-10-15T14:30:00Z",
            "UpdatedAt": "2025-10-17T09:15:00Z"
        },
        {
            "ID": "P5Q6R7S8",
            "UserID": "user_abc123xyz",
            "ProductID": 45678,
            "Status": "open",
            "Details": {
                "Trip": {
                    "ProductID": 45678,
                    "Name": "Hilton Garden Inn Rome - 4 Nights",
                    "StartDate": "2026-01-20",
                    "EndDate": "2026-01-24",
                    "City": "Rome",
                    "Country": "Italy",
                    "CountryCode": "IT"
                },
                "Items": [],
                "Travellers": [],
                "FirstName": "",
                "LastName": "",
                "Email": "",
                "TotalPrice": {
                    "Amount": 0,
                    "Currency": "EUR"
                },
                "Locale": "en"
            },
            "CreatedAt": "2025-10-16T16:30:00Z",
            "UpdatedAt": "2025-10-16T16:30:00Z"
        }
    ],
    "Error": null
}

Modified at 2025-10-16 13:54:41

Update booking status and trigger workflows

Get booking