Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.qflowhub.io/llms.txt

Use this file to discover all available pages before exploring further.

The Check-in API is the heart of Qflow’s event operations: anything you do in the dashboard around events, guests, and check-in is also available here. It’s what the Qflow mobile scanner apps use, what bulk-import tools talk to, and what most integrators wire into their ticketing or registration platforms.

​
Concepts

  • Event — a ticketed occasion with start/end times, branding, capacity, and a guest list. Identified by GUID.
  • Attendee (Guest) — a person on the guest list for an event. Carries name, email, plus-ones, tags, custom fields, and a barcode used at check-in. The terms guest and attendee are used interchangeably in the API.
  • Tag — a label attached to an attendee (ticket type, session, table number, dietary requirement). Tags drive filtering and reporting.
  • Tally — a real-time counter on an event (heads in / heads out / capacity-by-zone). Updated by check-in scanners or programmatically.
  • Team member — a staff account assigned to one or more events. Distinct from enterprise users.

​
When to use it

  • Bulk import — load attendees from a third-party ticketing system into a Qflow event.
  • Real-time sync — push attendee updates from your CRM as they happen (PUT /api/guests/{eventId}/upsert).
  • Search + lookup — find attendees by barcode, email, name, or custom info from your own UI.
  • Check-in / -out / tallies — drive scanners or replicate scanner behaviour from a custom client.
  • Block / unblock — programmatic enforcement of access rules.

​
URL pattern

All Check-in endpoints are routed through APIM at: 
https://api.qflowhub.io/checkin/v1/api/<endpoint>
Every request requires both an OAuth bearer token AND an Ocp-Apim-Subscription-Key header — see Authentication.

​
What’s in scope

Endpoints are grouped by tag in the API reference:
TagEndpoints
EventsEvent CRUD, statistics, export, enable/disable, tags
GuestsAttendee CRUD (single + bulk), search by barcode/email/name/info/tag/ticket, blocking, RSVP, check-in/out, undo
TalliesIncrement / decrement / read counters per event
TeamTeam-member CRUD, assignment to events
Bulk endpoints cap at 200 records per call — split larger batches. See the auto-generated API Reference for full schemas + try-it.

​
Key concepts to read first

Tags

The {tickettype}, {session}, {extra}, {merch}, {rsvp} prefixes that classify attendee tags. Learn what counts toward headline totals.

Check-in webhook

Get notified the moment an attendee is admitted — fires from API, dashboard, and scanner-app check-ins.

​
Rate limits

The Check-in API shares the zone-wide rate limit of 1000 requests / minute / IP applied to all of api.qflowhub.io.