Q-Hub APIs

💡 Please visit the below link for live technical information regarding APIs.

What’s possible with the Q-Hub API (beta)

1) Push and maintain “Data Sets” from other systems

• Create a Data Set externally (send data into Q-Hub)

• Update a Data Set (keep Q-Hub in sync when your source system changes)

Typical use: integrate your CRM/ERP/HR/training system so Q-Hub always has the latest structured data.

2) Pull operational records out of Q-Hub

• Get Form Entries (extract submitted form data)

• Get Process Entries (extract process-related records)

Typical use: build external reporting, BI dashboards, or downstream automations.

3) Automate user provisioning and access control

• Create a user (with access level and optional location assignments)

• Suspend a user (disable access but preserve data)

Key notes from the docs you pasted:

• Access levels include admin, standard, and view (view doesn’t consume a license seat; admin/standard are capped by licence tier).

• New users get an onboarding/verification email automatically.

• There are business rules around suspension (e.g., some users can’t be suspended under certain conditions).

4) Manage Locations (site structure) programmatically

• Create a location

• Update a location

• Archive a location

• Delete a location

Typical use: keep locations aligned with your org/site list, and automatically assign users to the right locations.

How the API works (integration basics)

• Auth uses API Key + API Secret sent on every request via headers: x-api-key and x-api-secret.

• HTTPS only, JSON responses (including JSON-formatted errors).

• Rate limit: 25 requests per 15 minutes per API key, with 429 on exceed; responses include rate-limit headers to help you throttle.

• Expect operational error patterns like 401 (bad/missing auth) and occasional 503 (traffic spike).

Q-Hub account API FAQs

Q: Who can access and use APIs?
A: To start with, only the main account admin can access the development centre and APIs

From the development centre on the get started page, the account admin can then allow additional admins to access the development centre and work with APIs. (Shown in red)

ℹ️ Find your account admin by navigating to the admin panel > Company > Section: Access and users limits. This shows you who the account admin user is.

Q: What should I do if the APIs are not working?
A: First check the documentation to ensure you have set-up the correct parameters, if you are still finding issues with getting the correct response with the API, then please raise a Help ticket from the support page.