API and AuthenticationCustomer API
Guest Flows
Retrieve guest pre-registration flows available to the authenticated customer
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-flowsExample 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.",
"maxGuestsPerSubmission": 3,
"availableGuestPassQuantity": 5,
"sublocationIds": ["sublocation_123"],
"hostedUrl": "https://portal.tiquo.app/guest-pre-registration/guest_flow_123?...",
"embedUrl": "https://portal.tiquo.app/embed/guest-pre-registration/guest_flow_123?..."
}
]
}
}| Field | Type | Description |
|---|---|---|
id | string | Guest-flow configuration ID |
label | string | Public flow label |
themeId | string | Theme used by the registration experience |
guestPassTypeId | string or omitted | Required guest-pass type when guest-pass limits are enabled |
inviteMessage | string | Configured invitation message |
maxGuestsPerSubmission | integer | Maximum guests accepted by one submission |
availableGuestPassQuantity | integer | Guest registrations currently available to this customer for the flow |
sublocationIds | string[] | Sublocations associated with the flow |
hostedUrl | string | Standalone guest-registration URL |
embedUrl | string | Embeddable guest-registration URL |
When no customer profile is linked, or no guest flow is available, the endpoint returns 200 OK with an empty guestFlows array.
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
| Status | Description |
|---|---|
401 | Missing, invalid, or expired access token |
500 | Internal server error |