Authentication
x-guest-portal-token: <HALLIFY_GUEST_PORTAL_TOKEN>Guest-owned portal session token.
Parameters
waitlistEntryIdPath · RequiredNative waitlist entry UUID in the current guest and venue realm.
string · uuidFull definition
{ "format": "uuid", "type": "string", "example": "9b6163a8-afea-4877-818b-8e2ae28a2845" }
Responses
200The exact guest-owned native waitlist state.
Full definition
{
"$ref": "#/components/schemas/GuestPortalWaitlistHistoryDetailsResultDto"
}{
"kind": "WAITLIST",
"id": "ffcb4a24-09bd-4656-8b6d-f4cf3347b92b",
"referenceCode": "EXAMPLE",
"revision": 1,
"status": "WAITING",
"joinedAt": "2026-01-15T12:00:00.000Z",
"partySize": 1,
"claimExpiresAt": null,
"quotedWaitMinMinutes": null,
"quotedWaitMaxMinutes": null,
"estimatedSeatAt": null,
"hasVerifiedSource": true
}400The native resource UUID or retained proof is invalid.
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 400,
"error": "errors:http.badRequest",
"code": "HTTP_BAD_REQUEST",
"message": "errors:http.badRequest",
"translationKey": "errors:http.badRequest"
}401The current Guest Portal session or subject is unavailable.
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 401,
"error": "errors:http.unauthorized",
"code": "HTTP_UNAUTHORIZED",
"message": "errors:http.unauthorized",
"translationKey": "errors:http.unauthorized"
}403The current session requires fresh contact verification before reading private history.
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 403,
"error": "errors:http.forbidden",
"code": "HTTP_FORBIDDEN",
"message": "errors:http.forbidden",
"translationKey": "errors:http.forbidden"
}404No readable resource exists in the exact guest and venue realm.
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 404,
"error": "errors:http.notFound",
"code": "HTTP_NOT_FOUND",
"message": "errors:http.notFound",
"translationKey": "errors:http.notFound"
}503The required protected-data key policy is unavailable.
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 503,
"error": "errors:http.serviceUnavailable",
"code": "HTTP_SERVICE_UNAVAILABLE",
"message": "errors:http.serviceUnavailable",
"translationKey": "errors:http.serviceUnavailable"
}Schemas
GuestPortalWaitlistHistoryDetailsResultDto
Assured guest-owned waitlist state without management authority.
kindRequiredNative waitlist resource kind.
stringFull definition
{ "type": "string", "enum": [ "WAITLIST" ], "description": "Native waitlist resource kind.", "example": "WAITLIST" }idRequiredCanonical native resource UUID.
string · uuidFull definition
{ "type": "string", "format": "uuid", "description": "Canonical native resource UUID.", "example": "ffcb4a24-09bd-4656-8b6d-f4cf3347b92b" }referenceCodeRequiredGuest-facing native waitlist reference.
stringFull definition
{ "type": "string", "description": "Guest-facing native waitlist reference.", "example": "EXAMPLE" }revisionRequiredCurrent revision owned by the native resource.
integerFull definition
{ "type": "integer", "minimum": 1, "description": "Current revision owned by the native resource.", "example": 1 }statusRequiredCurrent native waitlist lifecycle.
stringFull definition
{ "type": "string", "enum": [ "WAITING", "NOTIFIED", "CLAIMED", "SKIPPED", "SEATED", "CANCELED", "NO_SHOW" ], "description": "Current native waitlist lifecycle.", "example": "WAITING" }joinedAtRequiredOriginal native waitlist joining instant.
string · date-timeFull definition
{ "type": "string", "format": "date-time", "description": "Original native waitlist joining instant.", "example": "2026-01-15T12:00:00.000Z" }partySizeRequiredCurrent native number of guests.
integerFull definition
{ "type": "integer", "minimum": 1, "description": "Current native number of guests.", "example": 1 }claimExpiresAtRequiredStored native instant, or null when no such event occurred.
string · date-time · nullFull definition
{ "type": "string", "format": "date-time", "nullable": true, "description": "Stored native instant, or null when no such event occurred.", "example": "2026-12-31T18:00:00.000Z" }quotedWaitMinMinutesRequiredNative lower waiting-time quote in minutes, or null.
integer · nullFull definition
{ "type": "integer", "nullable": true, "description": "Native lower waiting-time quote in minutes, or null.", "example": 0 }quotedWaitMaxMinutesRequiredNative upper waiting-time quote in minutes, or null.
integer · nullFull definition
{ "type": "integer", "nullable": true, "description": "Native upper waiting-time quote in minutes, or null.", "example": 0 }estimatedSeatAtRequiredStored native instant, or null when no such event occurred.
string · date-time · nullFull definition
{ "type": "string", "format": "date-time", "nullable": true, "description": "Stored native instant, or null when no such event occurred.", "example": "2026-01-15T12:00:00.000Z" }hasVerifiedSourceRequiredA readable retained original-source proof exists. This flag issues no management, payment or bill authority; native entry still requires a new purpose-bound proof and current admission.
booleanFull definition
{ "type": "boolean", "description": "A readable retained original-source proof exists. This flag issues no management, payment or bill authority; native entry still requires a new purpose-bound proof and current admission.", "example": true }
Full definition
{
"type": "object",
"description": "Assured guest-owned waitlist state without management authority.",
"required": [
"kind",
"id",
"referenceCode",
"revision",
"status",
"joinedAt",
"partySize",
"claimExpiresAt",
"quotedWaitMinMinutes",
"quotedWaitMaxMinutes",
"estimatedSeatAt",
"hasVerifiedSource"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"WAITLIST"
],
"description": "Native waitlist resource kind.",
"example": "WAITLIST"
},
"id": {
"type": "string",
"format": "uuid",
"description": "Canonical native resource UUID.",
"example": "ffcb4a24-09bd-4656-8b6d-f4cf3347b92b"
},
"referenceCode": {
"type": "string",
"description": "Guest-facing native waitlist reference.",
"example": "EXAMPLE"
},
"revision": {
"type": "integer",
"minimum": 1,
"description": "Current revision owned by the native resource.",
"example": 1
},
"status": {
"type": "string",
"enum": [
"WAITING",
"NOTIFIED",
"CLAIMED",
"SKIPPED",
"SEATED",
"CANCELED",
"NO_SHOW"
],
"description": "Current native waitlist lifecycle.",
"example": "WAITING"
},
"joinedAt": {
"type": "string",
"format": "date-time",
"description": "Original native waitlist joining instant.",
"example": "2026-01-15T12:00:00.000Z"
},
"partySize": {
"type": "integer",
"minimum": 1,
"description": "Current native number of guests.",
"example": 1
},
"claimExpiresAt": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "Stored native instant, or null when no such event occurred.",
"example": "2026-12-31T18:00:00.000Z"
},
"quotedWaitMinMinutes": {
"type": "integer",
"nullable": true,
"description": "Native lower waiting-time quote in minutes, or null.",
"example": 0
},
"quotedWaitMaxMinutes": {
"type": "integer",
"nullable": true,
"description": "Native upper waiting-time quote in minutes, or null.",
"example": 0
},
"estimatedSeatAt": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "Stored native instant, or null when no such event occurred.",
"example": "2026-01-15T12:00:00.000Z"
},
"hasVerifiedSource": {
"type": "boolean",
"description": "A readable retained original-source proof exists. This flag issues no management, payment or bill authority; native entry still requires a new purpose-bound proof and current admission.",
"example": true
}
},
"example": {
"kind": "WAITLIST",
"id": "ffcb4a24-09bd-4656-8b6d-f4cf3347b92b",
"referenceCode": "EXAMPLE",
"revision": 1,
"status": "WAITING",
"joinedAt": "2026-01-15T12:00:00.000Z",
"partySize": 1,
"claimExpiresAt": null,
"quotedWaitMinMinutes": null,
"quotedWaitMaxMinutes": null,
"estimatedSeatAt": null,
"hasVerifiedSource": true
}
}TranslatedErrorDto
Stable error envelope emitted by the global HTTP exception boundary. Domain-specific machine data, when present, is nested under details.
statusCodeRequiredHTTP status code repeated from the response.
integerFull definition
{ "type": "integer", "description": "HTTP status code repeated from the response.", "example": 400 }errorRequiredTranslation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.
stringFull definition
{ "type": "string", "description": "Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.", "example": "errors.request.invalid" }codeRequiredStable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions.
stringFull definition
{ "type": "string", "example": "HTTP_BAD_REQUEST", "description": "Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions." }messageRequiredTranslation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application.
stringFull definition
{ "type": "string", "example": "errors:http.badRequest", "description": "Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application." }translationKeyRequiredCanonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback.
stringFull definition
{ "type": "string", "example": "errors:http.badRequest", "description": "Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback." }translationValuesOptionalOptional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.
objectFull definition
{ "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "example": "example" }, { "type": "number", "example": 0 }, { "type": "boolean", "example": true } ], "example": "example" }, "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.", "example": { "exampleKey": "example" } }validationErrorsOptionalField validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.
arrayFull definition
{ "description": "Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.", "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorDto" }, "example": [ { "field": "email", "translationKey": "validation:isEmail", "code": "isEmail", "message": "validation:isEmail" } ] }detailsOptionalOptional domain-specific blocker or validation details
oneOfFull definition
{ "description": "Optional domain-specific blocker or validation details", "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/JsonValue" }, "example": [ "example" ] }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "example": { "exampleKey": "example" } } ], "example": [ "example" ] }
Full definition
{
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"description": "HTTP status code repeated from the response.",
"example": 400
},
"error": {
"type": "string",
"description": "Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.",
"example": "errors.request.invalid"
},
"code": {
"type": "string",
"example": "HTTP_BAD_REQUEST",
"description": "Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions."
},
"message": {
"type": "string",
"example": "errors:http.badRequest",
"description": "Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application."
},
"translationKey": {
"type": "string",
"example": "errors:http.badRequest",
"description": "Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback."
},
"translationValues": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string",
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
}
],
"example": "example"
},
"description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
"example": {
"exampleKey": "example"
}
},
"validationErrors": {
"description": "Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationErrorDto"
},
"example": [
{
"field": "email",
"translationKey": "validation:isEmail",
"code": "isEmail",
"message": "validation:isEmail"
}
]
},
"details": {
"description": "Optional domain-specific blocker or validation details",
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonValue"
},
"example": [
"example"
]
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue"
},
"example": {
"exampleKey": "example"
}
}
],
"example": [
"example"
]
}
},
"required": [
"statusCode",
"error",
"code",
"message",
"translationKey"
],
"description": "Stable error envelope emitted by the global HTTP exception boundary. Domain-specific machine data, when present, is nested under details.",
"example": {
"statusCode": 400,
"error": "errors:http.badRequest",
"code": "HTTP_BAD_REQUEST",
"message": "errors:http.badRequest",
"translationKey": "errors:http.badRequest"
}
}ValidationErrorDto
Field validation failure with a field path, stable validator code and a translation key. Human-readable text belongs to the consuming application.
fieldRequiredPublic field path. Nested properties and array indices are separated by dots.
stringFull definition
{ "type": "string", "example": "email", "description": "Public field path. Nested properties and array indices are separated by dots." }translationKeyRequiredTranslation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog.
stringFull definition
{ "type": "string", "example": "validation:isEmail", "description": "Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog." }codeRequiredStable validator identifier for this field failure. Custom validators may define additional identifiers.
stringFull definition
{ "type": "string", "example": "isEmail", "description": "Stable validator identifier for this field failure. Custom validators may define additional identifiers." }messageRequiredTranslation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included.
stringFull definition
{ "type": "string", "example": "validation:isEmail", "description": "Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included." }translationValuesOptionalOptional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.
objectFull definition
{ "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "example": "example" }, { "type": "number", "example": 0 }, { "type": "boolean", "example": true } ], "example": "example" }, "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.", "example": { "exampleKey": "example" } }
Full definition
{
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "email",
"description": "Public field path. Nested properties and array indices are separated by dots."
},
"translationKey": {
"type": "string",
"example": "validation:isEmail",
"description": "Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog."
},
"code": {
"type": "string",
"example": "isEmail",
"description": "Stable validator identifier for this field failure. Custom validators may define additional identifiers."
},
"message": {
"type": "string",
"example": "validation:isEmail",
"description": "Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included."
},
"translationValues": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string",
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
}
],
"example": "example"
},
"description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
"example": {
"exampleKey": "example"
}
}
},
"required": [
"field",
"translationKey",
"code",
"message"
],
"description": "Field validation failure with a field path, stable validator code and a translation key. Human-readable text belongs to the consuming application.",
"example": {
"field": "email",
"translationKey": "validation:isEmail",
"code": "isEmail",
"message": "validation:isEmail"
}
}JsonValue
Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.
Full definition
{
"oneOf": [
{
"type": "string",
"nullable": true,
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonValue"
},
"example": [
"example"
]
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue"
},
"example": {
"exampleKey": "example"
}
}
],
"description": "Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.",
"example": "example"
}