Get waitlist entry

GET

brands

{brandId}

waitlist-invitation-offered

{waitlistEntryId}

Get waitlist entry

curl --request GET \
  --url https://api.letsway.com/v1/brands/{brandId}/waitlist-invitation-offered/{waitlistEntryId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.letsway.com/v1/brands/{brandId}/waitlist-invitation-offered/{waitlistEntryId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.letsway.com/v1/brands/{brandId}/waitlist-invitation-offered/{waitlistEntryId}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

{
  "id": "e3b1c9a7-2d4f-46b8-9c0a-1f2e3d4c5b6a",
  "status": "offered",
  "resourceGroupCollectionId": "9d8c7b6a-5e4f-4321-8765-43210fedcba9",
  "listingId": "d9fa9229-9132-415d-bc04-513062ee3bcd",
  "startDate": "2026-07-18",
  "startTime": "10:00",
  "sessionDuration": 60,
  "participants": [
    {
      "id": "019f5ca1-5432-751e-8663-7c22693a6e7e",
      "firstName": "Alice",
      "lastName": "Rivera",
      "cancelledAt": "2026-07-13T17:59:57.430Z",
      "emailAddress": "alice@example.com",
      "phoneNumber": "+15550100",
      "priceTierName": "Adult",
      "customQuestionAnswers": [
        {
          "id": "7d1f4a2e-3b6c-4c8d-9e0f-1a2b3c4d5e6f",
          "answer": [
            {
              "value": "<string>",
              "key": "f0e1d2c3-b4a5-4968-8776-655443322110"
            }
          ],
          "question": {
            "customQuestionId": "b2a1c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
            "prompt": "Do you have any dietary restrictions?",
            "fieldType": "single_select",
            "options": [
              {
                "key": "f0e1d2c3-b4a5-4968-8776-655443322110",
                "value": "Vegetarian"
              }
            ],
            "termsAndConditions": {
              "label": "I agree to the spa terms and conditions",
              "mediaId": "8c7b6a5d-4e3f-4210-9876-543210fedcba",
              "isOverrided": true,
              "mediaUrl": "https://cdn.letsway.com/media/spa-terms-and-conditions.pdf"
            },
            "config": {
              "experienceId": "c99f70ee-1c0e-4534-a31a-96d5d966cc4b",
              "experienceQuestionId": "5a4b3c2d-1e0f-4987-a654-321098765432",
              "isRequired": true,
              "isActive": true,
              "order": 1,
              "scope": "participant",
              "conditions": [
                {
                  "rule": "value_matches",
                  "conditionKey": "b2a1c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
                  "conditionValue": "f0e1d2c3-b4a5-4968-8776-655443322110"
                }
              ],
              "conditionsMatchType": "any"
            }
          }
        }
      ]
    }
  ],
  "purchaser": {
    "id": "019f5ca1-5432-751e-8663-7b999f0f7ede",
    "firstName": "Alice",
    "lastName": "Rivera",
    "emailAddress": "alice@example.com",
    "phoneNumber": "+15550100",
    "customQuestionAnswers": [
      {
        "id": "7d1f4a2e-3b6c-4c8d-9e0f-1a2b3c4d5e6f",
        "answer": [
          {
            "value": "<string>",
            "key": "f0e1d2c3-b4a5-4968-8776-655443322110"
          }
        ],
        "question": {
          "customQuestionId": "b2a1c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
          "prompt": "Do you have any dietary restrictions?",
          "fieldType": "single_select",
          "options": [
            {
              "key": "f0e1d2c3-b4a5-4968-8776-655443322110",
              "value": "Vegetarian"
            }
          ],
          "termsAndConditions": {
            "label": "I agree to the spa terms and conditions",
            "mediaId": "8c7b6a5d-4e3f-4210-9876-543210fedcba",
            "isOverrided": true,
            "mediaUrl": "https://cdn.letsway.com/media/spa-terms-and-conditions.pdf"
          },
          "config": {
            "experienceId": "c99f70ee-1c0e-4534-a31a-96d5d966cc4b",
            "experienceQuestionId": "5a4b3c2d-1e0f-4987-a654-321098765432",
            "isRequired": true,
            "isActive": true,
            "order": 1,
            "scope": "purchaser",
            "conditions": [
              {
                "rule": "value_matches",
                "conditionKey": "b2a1c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
                "conditionValue": "f0e1d2c3-b4a5-4968-8776-655443322110"
              }
            ],
            "conditionsMatchType": "any"
          }
        }
      }
    ]
  },
  "expiresAt": "2026-07-15T18:00:00.000Z"
}

Authorizations

Authorization

string

header

required

Your brand's secret API key, e.g. Bearer way_sk_live_bhEqcn0i1fRoUEHBPjJkQA. Older Way-Brand-Id + Way-Secret-Key credentials still work: see Legacy authentication.

Path Parameters

brandId

string

required

The brand's ID - must match the brand your API key identifies (or the Way-Brand-Id header when one is sent).

waitlistEntryId

string

required

A waitlist entry ID - sessions tied to this invitation are marked accordingly in the response.

Response

200 - application/json

Get waitlist entry.

string<uuid>

required

Unique identifier of the waitlist entry.

Example:

"e3b1c9a7-2d4f-46b8-9c0a-1f2e3d4c5b6a"

status

enum<string>

required

State of the waitlist entry: waiting (in line), opening-available (capacity has opened but no invitation has been sent yet), offered (the guest holds a time-boxed booking invitation), accepted, declined, expired (the invitation lapsed), or removed. This endpoint only returns entries with an active offer.

Available options:

removed,

waiting,

offered,

accepted,

declined,

expired,

opening-available

Example:

"offered"

resourceGroupCollectionId

string<uuid>

required

Identifier of the resource group collection (the bookable set of resources, such as a group of cabanas) the waitlist belongs to.

Example:

"9d8c7b6a-5e4f-4321-8765-43210fedcba9"

listingId

string<uuid> | null

required

Identifier of the listing that sells the resource group collection. Null when the collection has no listing.

Example:

"d9fa9229-9132-415d-bc04-513062ee3bcd"

startDate

string

required

Date of the session the guest is waitlisted for, in YYYY-MM-DD format.

Pattern: ^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$

Example:

"2026-07-18"

startTime

string

required

Start time of the session the guest is waitlisted for, in the property's local time (HH:mm or HH:mm:ss).

Pattern: ^([0-1]\d|2[0-3])(?::([0-5]\d)){1,2}$

Example:

"10:00"

sessionDuration

number

required

Length of the requested session in minutes.

Example:

60

participants

object[]

required

Guests included in the waitlist entry. They become the booking's participants if the invitation is accepted.

Show child attributes

purchaser

object

required

The guest who joined the waitlist and receives the booking invitation.

Show child attributes

expiresAt

string<date-time> | null

required

ISO 8601 timestamp when the booking invitation expires. Once passed, the entry can no longer be claimed and this endpoint returns 410 Gone.

Example:

"2026-07-15T18:00:00.000Z"

⌘I

Get waitlist entry

curl --request GET \
  --url https://api.letsway.com/v1/brands/{brandId}/waitlist-invitation-offered/{waitlistEntryId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.letsway.com/v1/brands/{brandId}/waitlist-invitation-offered/{waitlistEntryId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.letsway.com/v1/brands/{brandId}/waitlist-invitation-offered/{waitlistEntryId}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

{
  "id": "e3b1c9a7-2d4f-46b8-9c0a-1f2e3d4c5b6a",
  "status": "offered",
  "resourceGroupCollectionId": "9d8c7b6a-5e4f-4321-8765-43210fedcba9",
  "listingId": "d9fa9229-9132-415d-bc04-513062ee3bcd",
  "startDate": "2026-07-18",
  "startTime": "10:00",
  "sessionDuration": 60,
  "participants": [
    {
      "id": "019f5ca1-5432-751e-8663-7c22693a6e7e",
      "firstName": "Alice",
      "lastName": "Rivera",
      "cancelledAt": "2026-07-13T17:59:57.430Z",
      "emailAddress": "alice@example.com",
      "phoneNumber": "+15550100",
      "priceTierName": "Adult",
      "customQuestionAnswers": [
        {
          "id": "7d1f4a2e-3b6c-4c8d-9e0f-1a2b3c4d5e6f",
          "answer": [
            {
              "value": "<string>",
              "key": "f0e1d2c3-b4a5-4968-8776-655443322110"
            }
          ],
          "question": {
            "customQuestionId": "b2a1c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
            "prompt": "Do you have any dietary restrictions?",
            "fieldType": "single_select",
            "options": [
              {
                "key": "f0e1d2c3-b4a5-4968-8776-655443322110",
                "value": "Vegetarian"
              }
            ],
            "termsAndConditions": {
              "label": "I agree to the spa terms and conditions",
              "mediaId": "8c7b6a5d-4e3f-4210-9876-543210fedcba",
              "isOverrided": true,
              "mediaUrl": "https://cdn.letsway.com/media/spa-terms-and-conditions.pdf"
            },
            "config": {
              "experienceId": "c99f70ee-1c0e-4534-a31a-96d5d966cc4b",
              "experienceQuestionId": "5a4b3c2d-1e0f-4987-a654-321098765432",
              "isRequired": true,
              "isActive": true,
              "order": 1,
              "scope": "participant",
              "conditions": [
                {
                  "rule": "value_matches",
                  "conditionKey": "b2a1c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
                  "conditionValue": "f0e1d2c3-b4a5-4968-8776-655443322110"
                }
              ],
              "conditionsMatchType": "any"
            }
          }
        }
      ]
    }
  ],
  "purchaser": {
    "id": "019f5ca1-5432-751e-8663-7b999f0f7ede",
    "firstName": "Alice",
    "lastName": "Rivera",
    "emailAddress": "alice@example.com",
    "phoneNumber": "+15550100",
    "customQuestionAnswers": [
      {
        "id": "7d1f4a2e-3b6c-4c8d-9e0f-1a2b3c4d5e6f",
        "answer": [
          {
            "value": "<string>",
            "key": "f0e1d2c3-b4a5-4968-8776-655443322110"
          }
        ],
        "question": {
          "customQuestionId": "b2a1c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
          "prompt": "Do you have any dietary restrictions?",
          "fieldType": "single_select",
          "options": [
            {
              "key": "f0e1d2c3-b4a5-4968-8776-655443322110",
              "value": "Vegetarian"
            }
          ],
          "termsAndConditions": {
            "label": "I agree to the spa terms and conditions",
            "mediaId": "8c7b6a5d-4e3f-4210-9876-543210fedcba",
            "isOverrided": true,
            "mediaUrl": "https://cdn.letsway.com/media/spa-terms-and-conditions.pdf"
          },
          "config": {
            "experienceId": "c99f70ee-1c0e-4534-a31a-96d5d966cc4b",
            "experienceQuestionId": "5a4b3c2d-1e0f-4987-a654-321098765432",
            "isRequired": true,
            "isActive": true,
            "order": 1,
            "scope": "purchaser",
            "conditions": [
              {
                "rule": "value_matches",
                "conditionKey": "b2a1c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
                "conditionValue": "f0e1d2c3-b4a5-4968-8776-655443322110"
              }
            ],
            "conditionsMatchType": "any"
          }
        }
      }
    ]
  },
  "expiresAt": "2026-07-15T18:00:00.000Z"
}