The Enterprise API is the surface for administering users inside an enterprise. It’s the API equivalent of the team-management screens in the Qflow dashboard, scoped to the calling user’s enterprise.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.
When to use it
- Onboarding new staff — automated provisioning from your HR / SSO system into Qflow.
- Bulk credential rotation — periodic password resets without manual dashboard work.
- Username changes — when staff change names or email addresses.
- Lookups — find users by id or email for downstream automation.
Concepts
- Enterprise — a named group of users sharing branding and billing. Identified by an enterprise pin (a short string prefix).
- User — an account inside an enterprise. Username format is
{enterprisePin}/{email}for enterprise users; users without an enterprise have just the email. - Trust — separate from authentication. Some operations require the calling user to be marked
trusted(KYC complete) — see Authentication.
Authentication
All endpoints use the standard OAuth bearer token flow againstidentity.qflowhub.io. See Authentication for token retrieval.
URL pattern
All Enterprise endpoints are routed through APIM at:Ocp-Apim-Subscription-Key header — see Authentication.
What’s in scope
The Enterprise API covers user CRUD + credential management. Endpoints fall under theUsers tag in the API reference.
| Domain | Endpoints |
|---|---|
| User CRUD | GET /users/v1/api/user/{id}, GET /users/v1/api/users, GET /users/v1/api/users/email, POST /users/v1/api/user, PUT /users/v1/api/user, DELETE /users/v1/api/user |
| Credentials | PUT /users/v1/api/user/changepassword, PUT /users/v1/api/user/changeusername |
| Locale | GET /users/v1/api/user/translations |
| Reporting | GET /users/v1/api/users/total |