What is FlowIQ?
FlowIQ is our Conversations API that provides complete access to your WhatsApp conversation history, contact management, and analytics data. While FlowMod focuses on sending messages, FlowIQ specializes in retrieving and analyzing conversation data.Message Retrieval
Access complete conversation history with pagination and search
Contact Management
List, search, and manage your WhatsApp contacts
Analytics Ready
Structure data for business intelligence and reporting
Real-time Access
Retrieve the latest conversation data via REST API
Quick Example
Getting Started in 4 Steps
1
Create FlowIQ Account
Sign up at app.flowiq.live and connect your WhatsApp number
2
Get API Credentials
Navigate to Settings → API Keys to generate your bearer token and find your Tenant ID
3
Make Your First API Call
Use the REST API to retrieve conversation messages or contacts
4
Build Your Integration
Integrate conversation data into your applications, dashboards, or workflows
Key Features
1. Complete Conversation History
Access all messages from any WhatsApp conversation with rich metadata including:- Message content - Text, media URLs, and document links
- Sender information - User, bot, human agent, or system messages
- Status tracking - Sent, delivered, read, or failed
- Timestamps - Precise message timing for analytics
- Media types - Images, videos, audio, documents, and more
- Voice transcriptions - Automated transcription of voice notes
- Reactions - Emoji reactions and engagement metrics
2. Advanced Contact Management
Manage and search your WhatsApp contacts:- List all contacts with pagination support
- Search by name or phone number for quick lookups
- Contact details including profile pictures and last message
- Unread counts to track pending conversations
- Phone number lookup for specific contact retrieval
3. Analytics & Reporting
Build powerful analytics with structured data:- Message patterns and conversation flow analysis
- Response time metrics for support teams
- Engagement tracking through reactions and read status
- Media analysis to understand content types
- Agent performance with assignee tracking
API Capabilities
Conversation Messages API
Conversation Messages API
Retrieve messages from any WhatsApp conversation with filtering, pagination, and search.Key Parameters:
tenantId- Your FlowIQ tenant identifierwhatsappNumber- The WhatsApp number for the conversationlimit- Number of messages per page (default: 10, max: 100)page- Page number for paginationsearch- Search query to filter messages
- Message content and metadata
- Sender type and status
- Media URLs and types
- Voice note transcriptions
- Reactions and assignees
- Complete pagination information
Contact Listing API
Contact Listing API
List all your WhatsApp contacts with search and pagination capabilities.Key Parameters:
action=contacts- Specifies contact listing actiontenantId- Your FlowIQ tenant identifierlimit- Number of contacts per pagepage- Page numbersearch- Search by name or phone
- Contact name and number
- Profile picture URL
- Last message and timestamp
- Unread message count
- Pagination metadata
Phone Lookup API
Phone Lookup API
Find a specific contact by their WhatsApp phone number.Key Parameters:
action=find-by-phone- Specifies lookup actiontenantId- Your FlowIQ tenant identifierphoneNumber- WhatsApp number to lookup
- Contact name and details
- Profile picture URL
- Success/error status
Use Cases
Customer Support Analytics
Build dashboards to analyze support conversations, measure response times, and track customer satisfaction metrics.
CRM Integration
Automatically sync WhatsApp conversations with your CRM system for unified customer data management.
Automated Reporting
Generate daily, weekly, or monthly reports of conversation metrics, engagement, and team performance.
Message Search & Discovery
Search through conversation history to find specific information, orders, or customer requests.
Business Intelligence
Analyze conversation patterns, customer behavior, and trends for strategic decision-making.
Workflow Automation
Trigger automated workflows based on conversation events, message content, or contact actions.
Authentication
All FlowIQ API requests require Bearer token authentication:Getting Your Credentials
1
Login to Dashboard
Go to app.flowiq.live and sign in
2
Navigate to API Settings
Click on Settings → API Keys or Developer Settings
3
Generate Bearer Token
Create a new bearer token or copy your existing one
4
Find Tenant ID
Your Tenant ID is displayed in Settings or Account Information
5
Secure Your Credentials
Store them securely - never commit to version control
Understanding Message Data
Sender Types
FlowIQ identifies different message sources:| Type | Description | Use Case |
|---|---|---|
user-whatsapp | Message from the end user | Customer messages |
bot-whatsapp | Automated bot response | AI or chatbot replies |
human-whatsapp | Message from a human agent | Support team responses |
system | System notification or message | Status updates, system info |
Media Types
| Type | Description | Example Use Case |
|---|---|---|
image | Image files (JPG, PNG, etc.) | Product photos |
video | Video files | Demo videos |
audio | Audio files or voice notes | Voice messages |
document | Documents (PDF, DOCX, etc.) | Contracts, invoices |
interactive | Interactive messages (buttons, etc.) | Menu selections |
null | Text-only message | Regular text chat |
Message Status
| Status | Description | Meaning |
|---|---|---|
sent | Message sent successfully | In transit |
delivered | Message delivered to recipient | Reached recipient device |
read | Message read by recipient | Recipient opened message |
failed | Message failed to send | Error occurred during send |
Best Practices
Use Pagination
Always use
limit and page parameters to avoid overwhelming responses and improve performance.Implement Caching
Cache frequently accessed conversation data to reduce API calls and improve response times.
Error Handling
Always check the
success field in responses and implement retry logic with exponential backoff.Rate Limiting
Monitor rate limit headers and implement backoff strategies to avoid hitting limits.
Search Efficiently
Use search parameters to filter data at the API level rather than filtering large datasets locally.
Monitor Usage
Track your API usage patterns to optimize performance and identify potential issues early.
Complete Example Application
Here’s a complete example showing common FlowIQ operations:Next Steps
Complete Quickstart
Detailed step-by-step guide with more examples and use cases
API Reference
Complete API documentation with authentication details
Conversations Endpoint
Full endpoint documentation with all parameters and responses
Contact Management
Learn about contact management capabilities

