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.

Welcome to the Qflow developer documentation. Three APIs share the same authentication, the same host (api.qflowhub.io), and the same versioning policy:

Enterprise API

Create and manage users inside your enterprise — provisioning, credential changes, lookups.

Check-in API

Events, attendees, tags, RSVP, search, bulk import, and check-in / out / tally counters.

Comms API

Send transactional emails to attendees with optional PDF attachments and a custom sending domain.

​
What you’ll find here

Each API has:
  • A narrative overview — concepts, when to use, walked-through examples
  • An auto-generated reference — every endpoint, every schema, with an interactive try-it panel
The most common integration paths combine two or three APIs. For example, a typical ticketing-system integration:
  1. Use the Check-in API to create an event and load attendees
  2. Use the Comms API to send ticket-confirmation emails
  3. Use the Enterprise API (sometimes) to provision staff who’ll work the event

​
Shared infrastructure

  • Authentication — OAuth bearer tokens issued by identity.qflowhub.io. See Authentication.
  • Host — https://api.qflowhub.io for all three APIs.
  • Errors — standard HTTP status codes; structured error bodies for permanent failures (422).
  • Rate limits — zone-wide 1000 req/min/IP plus per-endpoint limits where applicable. Bulk endpoints capped at 200 records per call.
  • Versioning — additive changes ship without notice (build clients to ignore unknown fields). Breaking changes get a 90-day announcement.

​
Get started

1

Get a bearer token

See Authentication — OAuth password grant against identity.qflowhub.io/core/connect/token.
2

Pick the API for your use case

Read the relevant overview (Enterprise, Check-in, or Comms).
3

Try an endpoint

Use the interactive API Reference — paste your token, fill in the request, fire against the live API.
Need access enabled (Comms API specifically requires allow-listing) or have a question? Email support@qflowhub.io.