Authentication
x-guest-portal-token: <HALLIFY_GUEST_PORTAL_TOKEN>Guest-owned portal session token.
Parameters
No path, query or ordinary header parameters. See authentication and request body below.
Responses
200Returns the guest-owned profile, venue context, and editable-field revision.
Full definition
{
"$ref": "#/components/schemas/GuestPortalProfileResultDto"
}{
"guest": {
"id": "bd109aad-7d4b-40c6-8678-546bcd7bc5fe",
"identityId": "68927ddd-82be-42e0-8918-ef5107d35a10",
"displayName": "Example name",
"revision": 1,
"identityRevision": 1
}
}401Rejects a missing, malformed, expired, revoked, or invalid guestPortalToken credential at the owning domain boundary.
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 401,
"error": "errors:http.unauthorized",
"code": "HTTP_UNAUTHORIZED",
"message": "errors:http.unauthorized",
"translationKey": "errors:http.unauthorized"
}Schemas
GuestPortalProfileResultDto
Returns the guest-owned profile, venue context, and editable-field revision.
venueOptionalVenue details embedded in guest portal profile containing id, name, and currency. Null means no value is recorded for this representation.
object · nullFull definition
{ "required": [ "id", "name", "currency" ], "type": "object", "nullable": true, "properties": { "id": { "type": "string", "format": "uuid", "description": "Hallify UUID identifying guest portal profile venue.", "example": "fbc6db41-f1c2-4f74-862d-210bd28ee2a0" }, "name": { "type": "string", "description": "Human-readable name for guest portal profile venue.", "example": "Example name" }, "currency": { "type": "string", "description": "ISO 4217 currency code for the monetary values carried by guest portal profile venue.", "example": "GEL" } }, "description": "Venue details embedded in guest portal profile containing id, name, and currency. Null means no value is recorded for this representation.", "example": { "id": "fbc6db41-f1c2-4f74-862d-210bd28ee2a0", "name": "Example name", "currency": "GEL" } }guestRequiredGuest details embedded in guest portal profile containing id, identity id, display name, given name, family name, and email.
objectFull definition
{ "type": "object", "required": [ "id", "identityId", "displayName", "revision", "identityRevision" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Hallify UUID identifying guest portal profile guest.", "example": "bd109aad-7d4b-40c6-8678-546bcd7bc5fe" }, "identityId": { "type": "string", "format": "uuid", "description": "Hallify UUID identifying identity associated with guest portal profile guest.", "example": "68927ddd-82be-42e0-8918-ef5107d35a10" }, "displayName": { "type": "string", "description": "Human-readable display name for guest portal profile guest.", "example": "Example name" }, "givenName": { "type": "string", "nullable": true, "description": "Human-readable given name for guest portal profile guest. Null means no value is recorded for this representation.", "example": "Example name" }, "familyName": { "type": "string", "nullable": true, "description": "Human-readable family name for guest portal profile guest. Null means no value is recorded for this representation.", "example": "Example name" }, "email": { "type": "string", "nullable": true, "description": "Email address recorded for email in guest portal profile guest. Null means no value is recorded for this representation.", "format": "email", "example": "user@example.test" }, "phone": { "type": "string", "nullable": true, "description": "Telephone number recorded for phone in guest portal profile guest. Null means no value is recorded for this representation.", "example": "+995555000000" }, "preferredLanguage": { "type": "string", "nullable": true, "description": "BCP 47 language tag preferred for guest- or worker-facing communication in guest portal profile guest. Null means no value is recorded for this representation.", "example": "en" }, "defaultPartySize": { "type": "integer", "nullable": true, "description": "Whole-number default party size recorded for guest portal profile guest. Null means no value is recorded for this representation.", "example": 0 }, "revision": { "type": "integer", "description": "Monotonic optimistic-concurrency revision for guest portal profile guest.", "example": 1 }, "identityRevision": { "type": "integer", "description": "Monotonic optimistic-concurrency revision for guest portal profile guest.", "example": 1 } }, "description": "Guest details embedded in guest portal profile containing id, identity id, display name, given name, family name, and email.", "example": { "id": "bd109aad-7d4b-40c6-8678-546bcd7bc5fe", "identityId": "68927ddd-82be-42e0-8918-ef5107d35a10", "displayName": "Example name", "revision": 1, "identityRevision": 1 } }
Full definition
{
"type": "object",
"required": [
"guest"
],
"properties": {
"venue": {
"required": [
"id",
"name",
"currency"
],
"type": "object",
"nullable": true,
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Hallify UUID identifying guest portal profile venue.",
"example": "fbc6db41-f1c2-4f74-862d-210bd28ee2a0"
},
"name": {
"type": "string",
"description": "Human-readable name for guest portal profile venue.",
"example": "Example name"
},
"currency": {
"type": "string",
"description": "ISO 4217 currency code for the monetary values carried by guest portal profile venue.",
"example": "GEL"
}
},
"description": "Venue details embedded in guest portal profile containing id, name, and currency. Null means no value is recorded for this representation.",
"example": {
"id": "fbc6db41-f1c2-4f74-862d-210bd28ee2a0",
"name": "Example name",
"currency": "GEL"
}
},
"guest": {
"type": "object",
"required": [
"id",
"identityId",
"displayName",
"revision",
"identityRevision"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Hallify UUID identifying guest portal profile guest.",
"example": "bd109aad-7d4b-40c6-8678-546bcd7bc5fe"
},
"identityId": {
"type": "string",
"format": "uuid",
"description": "Hallify UUID identifying identity associated with guest portal profile guest.",
"example": "68927ddd-82be-42e0-8918-ef5107d35a10"
},
"displayName": {
"type": "string",
"description": "Human-readable display name for guest portal profile guest.",
"example": "Example name"
},
"givenName": {
"type": "string",
"nullable": true,
"description": "Human-readable given name for guest portal profile guest. Null means no value is recorded for this representation.",
"example": "Example name"
},
"familyName": {
"type": "string",
"nullable": true,
"description": "Human-readable family name for guest portal profile guest. Null means no value is recorded for this representation.",
"example": "Example name"
},
"email": {
"type": "string",
"nullable": true,
"description": "Email address recorded for email in guest portal profile guest. Null means no value is recorded for this representation.",
"format": "email",
"example": "user@example.test"
},
"phone": {
"type": "string",
"nullable": true,
"description": "Telephone number recorded for phone in guest portal profile guest. Null means no value is recorded for this representation.",
"example": "+995555000000"
},
"preferredLanguage": {
"type": "string",
"nullable": true,
"description": "BCP 47 language tag preferred for guest- or worker-facing communication in guest portal profile guest. Null means no value is recorded for this representation.",
"example": "en"
},
"defaultPartySize": {
"type": "integer",
"nullable": true,
"description": "Whole-number default party size recorded for guest portal profile guest. Null means no value is recorded for this representation.",
"example": 0
},
"revision": {
"type": "integer",
"description": "Monotonic optimistic-concurrency revision for guest portal profile guest.",
"example": 1
},
"identityRevision": {
"type": "integer",
"description": "Monotonic optimistic-concurrency revision for guest portal profile guest.",
"example": 1
}
},
"description": "Guest details embedded in guest portal profile containing id, identity id, display name, given name, family name, and email.",
"example": {
"id": "bd109aad-7d4b-40c6-8678-546bcd7bc5fe",
"identityId": "68927ddd-82be-42e0-8918-ef5107d35a10",
"displayName": "Example name",
"revision": 1,
"identityRevision": 1
}
}
},
"description": "Returns the guest-owned profile, venue context, and editable-field revision.",
"example": {
"guest": {
"id": "bd109aad-7d4b-40c6-8678-546bcd7bc5fe",
"identityId": "68927ddd-82be-42e0-8918-ef5107d35a10",
"displayName": "Example name",
"revision": 1,
"identityRevision": 1
}
}
}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"
}