fiq_ API key as the rest of the API. It’s read-only: no report can send, change or delete anything.
Live report reference
Every report with its parameters, defaults and a try-it form. Generated from the running code, so it’s always current. Machine-readable version:
/reports/openapi.json.Authentication
URLs and versioning
Report names are snake_case (
get_account_stats); hyphens work too (get-account-stats).
Running a report
Pass parameters as a query string onGET, or as a JSON body on POST (the body wins if both set the same parameter).
YYYY-MM-DD) read in the timezone parameter, which defaults to Africa/Johannesburg.
Response
Listing reports
GET https://api.flowiq.live/reports with your key returns every report your key can run, with its description and parameters, as JSON. Without a key the same URL opens the readable reference.
Available reports
The live reference is the authoritative list; reports added after this page was written appear there first.
Syncing your tickets
list_tickets pages through every ticket and can hand you only what changed, so you can keep a copy in your own database or warehouse.
- First run: call it with
order=updatedandlimit=200, then keep passingdata.next_cursorback ascursoruntil it isnull. Every ticket comes back once, oldest change first. - Later runs: pass
updated_sincewith the time your last run started. You get each ticket created or changed since then: a status change, a reply, a new assignee, a label, a follow-up. - Nothing is missed: this order leaves out changes from the last 15 seconds, so a change still being saved can’t land behind a cursor you’ve already stored. Store either the last
next_cursoror the time your run started, and carry on from there next time. - Rather be told? Register a ticket webhook and FlowIQ POSTs each change as it happens, with the same ticket object
get_ticketreturns. Keep a nightlyupdated_sincerun as the safety net. updated_aton a ticket is when anything on it last changed. Each ticket also carries its number, status and team status, channel, customer, assignee, labels, follow-up, reply times, and when it was raised and resolved.get_ticketadds the status history and the AI’s notes on the case.
First run, then page with the cursor
Only what changed since your last run
One ticket by its number
list_tickets looks like this:
status, needs_reply, assignee (a name, a member id or unassigned), label and team_status (a name, an id or none), team_id, channel, contact_id, and start_date / end_date for the days a ticket was raised. Keep the same filters and order while you page.
Contact reasons
If your account tags conversations with a contact reason, the same pattern works for them.get_contact_reasons returns the Contact reasons report for a period (the last 30 days by default): customer conversations by reason, product and issue, per 100 orders, before and after purchase. list_contact_reasons returns one row per conversation with its product, contact reason, issue detail, order number, channel and customer, and pages and syncs exactly like list_tickets (order=updated, updated_since, cursor). Filter by contact_reason, product or issue_detail by name.
Every tagged conversation changed since your last run

