Guest Book

Working with the restaurant’s guest base: listing, search, creating and editing profiles, the guest card with visit history. Through these endpoints a partner app (CRM, POS, marketing service) can sync its customer base, enrich profiles with guest preferences and retrieve their visit history.

All endpoints require a Bearer token (see Authentication). General request conventions and the error format are covered in Conventions and Errors.

Base path: /api/loyalty/admin/restaurants/{restaurantId}/....

Historically the guest base is served under the /api/loyalty/... prefix, and the entity in the API is called member. In this documentation it is simply a guest — with no tie to a loyalty program.

Guest profile (CustomerContract)

Most read endpoints return a CustomerContract object — the full guest card. The key fields are below. Read-only fields (aggregates, visit counters) are computed by the system and ignored on create/update.

Identity and contacts

Preferences and flags

Important dates

Guest statistics (read-only)

Nested objects

List guests

GET /members

Returns the restaurant’s guests with OData filtering, sorting and paging.

Parameters

Example

curl -G https://api.hostmeapp.com/api/loyalty/admin/restaurants/123/members \
  -H "Authorization: Bearer $TOKEN" \
  --data-urlencode '$top=50' \
  --data-urlencode '$orderby=lastVisitDate desc'

The exact schema of the successful (200) response is not captured in the spec. In practice the endpoint returns a collection of guests (CustomerContract); for a paged variant with a total count use GET /members/search.

Create a guest

POST /members

Creates a new guest in the restaurant’s base. Body — CustomerUpdateContract.

Body fields

Example

curl -X POST https://api.hostmeapp.com/api/loyalty/admin/restaurants/123/members \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "fullName": "John Parker",
    "phoneNumber": "+16175550123",
    "email": "ivan@example.com",
    "vip": true,
    "vegetarian": false,
    "allergy": ["nuts"],
    "tablePreferences": "Window table",
    "guestTags": [{ "name": "Regular", "color": "#DD7352" }]
  }'

Response. On success — 201 Created with the created guest (CustomerContract). Documented errors: body — ProblemDetails (see Errors).

Get a guest

GET /members/{memberId}

Returns a guest by identifier.

Update a guest

PUT /members/{memberId}

Updates the guest profile. Body — the same CustomerUpdateContract as on create; send the fields you want to change.

curl -X PUT https://api.hostmeapp.com/api/loyalty/admin/restaurants/123/members/456 \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "aboutGuestNotes": "Prefers a window table", "vip": true }'

Delete a guest

DELETE /members/{memberId}

Removes the guest from the restaurant’s base.

curl -X DELETE https://api.hostmeapp.com/api/loyalty/admin/restaurants/123/members/456 \
  -H "Authorization: Bearer $TOKEN"

Find by phone

GET /members/find

Looks up a guest by phone number — handy before creating one, to avoid duplicates.

curl -G https://api.hostmeapp.com/api/loyalty/admin/restaurants/123/members/find \
  -H "Authorization: Bearer $TOKEN" \
  --data-urlencode "phoneNumber=+16175550123"

Find by email

GET /members/email/{email}

Looks up a guest by email address.

curl https://api.hostmeapp.com/api/loyalty/admin/restaurants/123/members/email/ivan@example.com \
  -H "Authorization: Bearer $TOKEN"

Paged search

GET /members/search

Paged guest search with an OData filter and a continuation token. Returns a PagedResult with an array of full profiles and the total count.

Parameters

Response (PagedResult<CustomerContract>)

curl -G https://api.hostmeapp.com/api/loyalty/admin/restaurants/123/members/search \
  -H "Authorization: Bearer $TOKEN" \
  --data-urlencode '$filter=contains(fullName,'"'"'John'"'"')' \
  --data-urlencode 'take=25'

Lightweight profile list

GET /members/filter

Returns simplified guest cards (CustomerProfileContract) — useful for lists and autocomplete where the full statistics aren’t needed.

Parameters

Response — array of CustomerProfileContract

Export the guest base

POST /members/export

Starts an export of the guest list (e.g. to a file/download). Body — ExportInfoCustomersContract.

curl -X POST https://api.hostmeapp.com/api/loyalty/admin/restaurants/123/members/export \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "filter": "vip eq true" }'

Response. 201 Created — the export has been accepted for processing.

Visit history

Three endpoints return a guest’s visits in different slices. All accept an optional restaurantIds — to aggregate history across several restaurants of a chain.

Past visits

GET /members/{memberId}/visits

Current visits

GET /members/{memberId}/inprogress

Visits happening right now (the guest is seated).

Upcoming visits

GET /members/{memberId}/upcomingvisits

The guest’s future reservations.

curl -G https://api.hostmeapp.com/api/loyalty/admin/restaurants/123/members/456/visits \
  -H "Authorization: Bearer $TOKEN" \
  --data-urlencode "take=20" \
  --data-urlencode "orderBy=date desc"

Guest card

Guest card

GET /customer/{memberId}

Returns the guest card by identifier.

Guest details

GET /guest/{memberId}/details

Returns detailed information about the guest.

curl https://api.hostmeapp.com/api/loyalty/admin/restaurants/123/customer/ABC_ID \
  -H "Authorization: Bearer $TOKEN"

The exact response schemas for the guest card and guest details are not captured in the spec — in practice a guest profile with aggregated statistics is returned (close to CustomerContract).