Skip to main content
GET
/
v1
/
listings
/
{listingId}
Get listing
curl --request GET \
  --url https://api.letsway.com/v1/listings/{listingId}
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "type": "recurring",
  "partySize": 123,
  "headline": "<string>",
  "vibes": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  ],
  "category": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "coverPicture": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "uri": {
      "384w": "<string>",
      "480w": "<string>",
      "640w": "<string>",
      "750w": "<string>",
      "1080w": "<string>",
      "original": "<string>"
    }
  },
  "firstAvailableDate": {
    "scheduledDate": "<string>",
    "sessions": [
      {
        "startTime": "<string>",
        "duration": 123,
        "supportedParticipantsCount": 123,
        "priceTiers": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "price": 123
          }
        ],
        "availableQuantityPerTier": {}
      }
    ]
  },
  "kind": "experience",
  "eventType": "general_admission",
  "productLine": "activate",
  "slug": "<string>",
  "defaultPriceTiers": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "price": 123,
      "maxQuantity": 1
    }
  ],
  "conditionalPriceTiers": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "price": 123,
      "maxQuantity": 1
    }
  ],
  "defaultMaxParticipantCount": 123,
  "description": "<string>",
  "location": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "additionalInfo": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "longitude": 123,
    "latitude": 123,
    "timezoneId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "isBookable": true,
  "isUnlisted": true,
  "hostedBy": {
    "id": "<string>",
    "fullName": "<string>",
    "profilePicture": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "uri": {
        "48w": "<string>",
        "256w": "<string>",
        "original": "<string>"
      }
    },
    "firstName": "<string>",
    "lastName": "<string>",
    "allowOverlappingBookings": true,
    "description": "<string>"
  },
  "isCurated": true,
  "isExclusive": true,
  "hidePrice": true,
  "bookingAvailabilityMode": "private",
  "descriptionPicture": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "uri": {
      "384w": "<string>",
      "480w": "<string>",
      "640w": "<string>",
      "750w": "<string>",
      "1080w": "<string>",
      "original": "<string>"
    }
  },
  "paymentMethods": [
    "credit-card"
  ],
  "taxes": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "includedInPrice": true,
      "percentage": 1,
      "name": "<string>"
    }
  ],
  "integrationMeta": [
    {
      "type": "opera",
      "key": "transactionCode",
      "value": {}
    }
  ],
  "providedItems": [
    "<string>"
  ],
  "reminder": "<string>",
  "pictures": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "uri": {
        "384w": "<string>",
        "480w": "<string>",
        "640w": "<string>",
        "750w": "<string>",
        "1080w": "<string>",
        "original": "<string>"
      },
      "kind": "gallery"
    }
  ],
  "medias": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "image",
      "links": [
        {
          "type": "image",
          "url": "<string>",
          "resolution": "original"
        }
      ],
      "kind": "gallery",
      "order": 1
    }
  ],
  "ratings": {
    "rating": 123,
    "recommendability": 123,
    "total": 123
  },
  "minimumRequiredToBook": 1,
  "maximumAllowedToBook": 1,
  "externalField": {
    "type": "url",
    "value": "<string>"
  },
  "map": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "uri": {
      "384w": "<string>",
      "480w": "<string>",
      "640w": "<string>",
      "750w": "<string>",
      "1080w": "<string>",
      "original": "<string>"
    }
  },
  "resourceGroups": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order": 123,
      "resourceGroupCollectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version": "latest",
      "pictures": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "uri": {
            "384w": "<string>",
            "480w": "<string>",
            "640w": "<string>",
            "750w": "<string>",
            "1080w": "<string>",
            "original": "<string>"
          }
        }
      ],
      "medias": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "image",
          "links": [
            {
              "type": "image",
              "url": "<string>",
              "resolution": "original"
            }
          ],
          "kind": "gallery",
          "order": 1
        }
      ],
      "title": "<string>",
      "description": "<string>",
      "included": [
        "<string>"
      ],
      "experiences": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "title": "<string>",
          "description": "<string>",
          "status": "draft",
          "version": "latest",
          "isUnlisted": true,
          "displayedCapacity": 123,
          "position": {
            "x": 123,
            "y": 123
          },
          "onlineBookingCutoffHours": 123,
          "emailMessage": "<string>",
          "notificationOverrides": {
            "email": {
              "booking:confirmation": {
                "enabled": true
              },
              "booking:refunded": {
                "enabled": true
              },
              "booking:cancelled": {
                "enabled": true
              },
              "booking:rescheduled": {
                "enabled": true
              },
              "review:request": {
                "enabled": true,
                "config": {
                  "value": 123,
                  "cadence": "hours_after"
                }
              },
              "review:reminder": {
                "enabled": true,
                "config": {
                  "value": 123,
                  "cadence": "hours_after"
                }
              },
              "event:reminder": {
                "enabled": true,
                "config": {
                  "value": 123,
                  "cadence": "hours_before"
                }
              },
              "event:second-reminder": {
                "enabled": true,
                "config": {
                  "value": 123,
                  "cadence": "hours_before"
                }
              }
            },
            "sms": {
              "booking:confirmation": {
                "enabled": true
              },
              "booking:refunded": {
                "enabled": true
              },
              "booking:cancelled": {
                "enabled": true
              },
              "booking:rescheduled": {
                "enabled": true
              },
              "event:reminder": {
                "enabled": true,
                "config": {
                  "value": 123,
                  "cadence": "hours_before"
                }
              },
              "event:second-reminder": {
                "enabled": true,
                "config": {
                  "value": 123,
                  "cadence": "hours_before"
                }
              }
            }
          },
          "notificationEmails": [
            "<string>"
          ],
          "paymentMethods": [
            "credit-card"
          ],
          "kind": "experience",
          "shouldValidateComplimentaryBooking": {
            "memberCharge": true,
            "roomCharge": true
          },
          "integrationMeta": [
            {
              "type": "opera",
              "key": "transactionCode",
              "value": {}
            }
          ],
          "sessionDurationMinutes": 2,
          "taxes": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "includedInPrice": true,
              "percentage": 1
            }
          ],
          "type": "recurring",
          "maximumAllowedToBook": 123,
          "minimumRequiredToBook": 123,
          "maxParticipantsCount": 1,
          "bookingAvailabilityMode": "private",
          "cancellationPolicyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "reschedulePolicyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "shape": {
            "type": "circle",
            "width": 123,
            "height": 123,
            "color": "<string>"
          },
          "customQuestions": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "prompt": "<string>",
              "fieldType": "input",
              "options": [
                {
                  "key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "value": "<string>"
                }
              ],
              "termsAndConditions": {
                "label": "<string>",
                "mediaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "mediaURL": "<string>",
                "isOverrided": true
              },
              "config": {
                "isRequired": true,
                "scope": "purchaser",
                "conditionsMatchType": "any",
                "isActive": true,
                "conditions": [
                  {
                    "rule": "value_matches",
                    "conditionKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "conditionValue": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                  }
                ],
                "order": 123,
                "isDefault": true,
                "disabled": true
              }
            }
          ],
          "number": "<string>",
          "isTicketed": true,
          "priceTiers": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "name": "<string>",
              "price": 123,
              "maxQuantity": 1
            }
          ],
          "priceTierRules": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "name": "<string>",
              "order": 123,
              "type": "rule",
              "isActive": true,
              "conditions": [
                {
                  "type": "date_range",
                  "param": [
                    {
                      "from": "<string>",
                      "to": "<string>"
                    }
                  ]
                }
              ],
              "priceTiers": [
                {
                  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "name": "<string>",
                  "price": 123,
                  "maxQuantity": 1
                }
              ]
            }
          ]
        }
      ],
      "defaultShape": {
        "type": "circle",
        "width": 123,
        "height": 123,
        "color": "<string>"
      },
      "numberPattern": "numeric",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "defaultPriceTiers": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "price": 123,
          "maxQuantity": 1
        }
      ],
      "reminder": "<string>",
      "taxes": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "includedInPrice": true,
          "percentage": 1,
          "name": "<string>"
        }
      ],
      "paymentMethods": [
        "credit-card"
      ],
      "integrationMeta": [
        {
          "type": "opera",
          "key": "transactionCode",
          "value": {}
        }
      ],
      "providedItems": [
        "<string>"
      ],
      "minimumRequiredToBook": 1,
      "maximumAllowedToBook": 1,
      "ratings": {
        "rating": 123,
        "recommendability": 123,
        "total": 123
      },
      "isExclusive": true,
      "firstAvailableDate": {
        "scheduledDate": "<string>",
        "sessions": [
          {
            "startTime": "<string>",
            "duration": 123,
            "supportedParticipantsCount": 123,
            "priceTiers": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "name": "<string>",
                "price": 123
              }
            ],
            "availableQuantityPerTier": {}
          }
        ]
      },
      "shouldValidateComplimentaryBooking": true,
      "addOns": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "label": "<string>",
          "description": "<string>",
          "status": "available",
          "price": 1,
          "picture": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "uri": {
              "360w": "<string>",
              "720w": "<string>",
              "1080w": "<string>",
              "original": "<string>"
            }
          },
          "taxes": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "includedInPrice": true,
              "amount": 1,
              "name": "<string>"
            }
          ],
          "limit": {
            "type": "PER_PARTICIPANT",
            "value": 1
          }
        }
      ]
    }
  ],
  "brandId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isFeatured": true,
  "cancellationPolicyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reschedulePolicyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customCallToAction": "<string>",
  "agenda": "<string>",
  "menu": "<string>",
  "dates": [
    "<string>"
  ],
  "startTimes": [
    "<string>"
  ],
  "supportedCurrencies": [
    "AED"
  ],
  "shouldValidateComplimentaryBooking": true,
  "waitlistId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "addOns": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "label": "<string>",
      "description": "<string>",
      "status": "available",
      "price": 1,
      "picture": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "uri": {
          "360w": "<string>",
          "720w": "<string>",
          "1080w": "<string>",
          "original": "<string>"
        }
      },
      "taxes": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "includedInPrice": true,
          "amount": 1,
          "name": "<string>"
        }
      ],
      "limit": {
        "type": "PER_PARTICIPANT",
        "value": 1
      }
    }
  ],
  "customQuestions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "prompt": "<string>",
      "fieldType": "input",
      "options": [
        {
          "key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "value": "<string>"
        }
      ],
      "termsAndConditions": {
        "label": "<string>",
        "mediaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "mediaURL": "<string>",
        "isOverrided": true
      },
      "config": {
        "isRequired": true,
        "scope": "purchaser",
        "conditionsMatchType": "any",
        "isActive": true,
        "conditions": [
          {
            "rule": "value_matches",
            "conditionKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "conditionValue": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "order": 123,
        "isDefault": true,
        "disabled": true
      }
    }
  ],
  "listingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "promotedListingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "promotedListingStatus": "needs-approval",
  "providerBrandId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "providerBrandName": "<string>",
  "auction": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "brandId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "resourceGroupCollectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "preview",
    "biddingOpenDateTime": "2023-11-07T05:31:56Z",
    "biddingCloseDateTime": "2023-11-07T05:31:56Z",
    "claimTimeMinutes": 123,
    "publishedStatus": "preview",
    "winningAmount": "<string>",
    "winningBidderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "bidsCount": 123,
    "uniqueBiddersCount": 123,
    "startingAmount": "<string>",
    "minBidIncrement": "<string>"
  }
}

Path Parameters

​
listingId
string

Query Parameters

​
version
enum<string>
Available options:
published,
latest
​
language
enum<string>
Available options:
de-DE,
en-GB,
en-US,
es-ES,
fr-FR,
it-IT,
ja-JP,
ko-KR,
pt-BR,
ru-RU,
zh-Hans,
zh-Hant

Response

200 - application/json

Listing

​
id
string<uuid>
required
​
title
string
required
​
type
enum<string> | null
required
Available options:
recurring,
one-time
​
partySize
number | null
required
​
headline
string
required
​
vibes
object[]
required
​
category
object
required
​
coverPicture
object
required
​
firstAvailableDate
object
required
​
kind
enum<string>
required
Available options:
experience,
resource,
event,
auction
​
eventType
enum<string> | null
required
Available options:
general_admission,
reserved_seating,
auction
​
productLine
enum<string>
required
Available options:
activate,
host,
reserve
​
slug
string | null
required
​
defaultPriceTiers
object[]
required
​
conditionalPriceTiers
object[] | null
required
​
defaultMaxParticipantCount
number | null
required
​
description
string
required
​
location
object
required
​
isBookable
boolean
required
​
isUnlisted
boolean
required
​
hostedBy
object
required
​
isCurated
boolean
required
​
isExclusive
boolean
required
​
hidePrice
boolean
required
​
bookingAvailabilityMode
enum<string> | null
required
Available options:
private,
group,
non-restricted
​
descriptionPicture
object
required
​
paymentMethods
enum<string>[] | null
required
Available options:
credit-card,
room-charge,
member-number,
loyalty,
kicc,
cash,
pay-later,
pay-upon-arrival
​
taxes
object[] | null
required
​
integrationMeta
object[] | null
required
​
providedItems
string[] | null
required
​
reminder
string | null
required
​
pictures
object[]
required
​
medias
object[]
required
​
ratings
object
required
​
minimumRequiredToBook
number | null
required
Required range: x >= 0
​
maximumAllowedToBook
number | null
required
Required range: x >= 0
​
externalField
object
required
​
map
object
required
​
resourceGroups
object[] | null
required
​
brandId
string<uuid>
required
​
isFeatured
boolean
required
​
cancellationPolicyId
string<uuid> | null
required
​
reschedulePolicyId
string<uuid> | null
required
​
customCallToAction
string | null
required
​
agenda
string | null
required
​
menu
string | null
required
​
dates
string[] | null
required
​
startTimes
string[] | null
required
​
supportedCurrencies
enum<string>[]
required
Available options:
AED,
ALL,
AMD,
AOA,
ARS,
AUD,
AZN,
BAM,
BDT,
BGN,
BHD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
CAD,
CHF,
CLP,
COP,
CRC,
CZK,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
GBP,
GHS,
GMD,
GTQ,
GYD,
HKD,
HUF,
IDR,
ILS,
INR,
JMD,
JOD,
JPY,
KES,
KHR,
KRW,
KWD,
KZT,
LAK,
LKR,
MAD,
MDL,
MGA,
MKD,
MNT,
MOP,
MUR,
MXN,
MYR,
MZN,
NAD,
NGN,
NOK,
NZD,
OMR,
PEN,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RWF,
SAR,
SEK,
SGD,
THB,
TND,
TRY,
TTD,
TWD,
TZS,
USD,
UYU,
UZS,
VND,
XAF,
XCD,
XOF,
ZAR
​
shouldValidateComplimentaryBooking
boolean | null
required
​
waitlistId
string<uuid> | null
required
​
addOns
object[]
required
​
customQuestions
object[] | null
required
​
listingId
string<uuid> | null
​
promotedListingId
string<uuid> | null
​
promotedListingStatus
enum<string> | null
Available options:
needs-approval,
needs-provider-approval,
needs-promoter-approval,
approved,
declined
​
providerBrandId
string<uuid> | null
​
providerBrandName
string | null
​
auction
object