Guest Flows

Returns the organization's configured guest pre-registration flows for the authenticated customer. Generated URLs contain presentation and registration configuration; customer credentials are not placed in them.

Endpoint

GET /guest-flows

Example Request

curl "https://edge.tiquo.app/api/client/v1/guest-flows" \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9..."

Response

{
  "success": true,
  "data": {
    "guestFlows": [
      {
        "id": "guest_flow_123",
        "label": "Invite a guest",
        "themeId": "theme_123",
        "guestPassTypeId": "pass_type_123",
        "inviteMessage": "Register your guest before arrival.",
        "venueName": "Main Club",
        "locations": [{ "id": "location_123", "name": "Main Club" }],
        "maxGuestsPerSubmission": 3,
        "availableGuestPassQuantity": 5,
        "locationIds": ["location_123"],
        "hostedUrl": "https://portal.tiquo.app/guest-pre-registration/guest_flow_123?...",
        "embedUrl": "https://portal.tiquo.app/embed/guest-pre-registration/guest_flow_123?..."
      }
    ]
  }
}

When no customer profile is linked, or no guest flow is available, the endpoint returns 200 OK with an empty guestFlows array.

Locations and pass use

Guest Flows are configured against parent locations, not individual sublocations. A location is offered only when it has a sublocation that allows guest registration. Show a Location selector when locations has more than one entry. Use the only entry automatically when there is one. Do not render a sublocation selector from this response.

The selected location's name supplies the {{venue}} invitation variable. locationIds replaces the legacy sublocationIds flow field. New integrations should use locationIds and locations.

Sending an invitation reserves a Guest Pass in limited mode. Acceptance holds the reservation; staff registration consumes it. In unlimited mode, guestPassTypeId is omitted and availableGuestPassQuantity is not an owned pass balance. A returned flow can have zero available uses in limited mode, so do not treat its presence as proof that another invitation can be sent.

This endpoint lists invitation flows, not the customer's sent or received invitations. For the staff and customer behaviour, see Guest Passes and Customer Registration.

Hosted Package

The Hosted Package exposes this endpoint as window.Tiquo.getGuestFlows() and can render it with the data-tiquo-guest-flows collection attribute.

const { guestFlows } = await window.Tiquo.getGuestFlows();

Errors