Skip to main content
Get started with FlowIQ API. This guide assumes you already have a FlowIQ account set up at app.flowiq.live.

​
Prerequisites

You need:
  • FlowIQ account with connected WhatsApp
  • Bearer token
  • Tenant ID

​
1. Get Your Credentials

Navigate to your FlowIQ dashboard settings to retrieve:
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
Security Best Practices:
  • Never expose your bearer token in client-side code
  • Store credentials in environment variables
  • Use HTTPS for all API calls

​
2. Retrieve Conversation Messages

curl -X GET "https://api.flowiq.live/conversations?tenantId=YOUR_TENANT_ID&whatsappNumber=27123456789&limit=10" \
  -H "Authorization: Bearer YOUR_BEARER_TOKEN"

​
3. List All Contacts

curl -X GET "https://api.flowiq.live/conversations?action=contacts&tenantId=YOUR_TENANT_ID&limit=20" \
  -H "Authorization: Bearer YOUR_BEARER_TOKEN"

​
4. Search Specific Contact

curl -X GET "https://api.flowiq.live/conversations?action=find-by-phone&tenantId=YOUR_TENANT_ID&phoneNumber=27123456789" \
  -H "Authorization: Bearer YOUR_BEARER_TOKEN"

​
Understanding the Response

​
Conversation Messages Response

{
  "success": true,
  "messages": [
    {
      "id": "message_id",
      "content": "Hello, how can I help you?",
      "sender": "user-whatsapp",
      "status": "read",
      "mediaType": null,
      "mediaUrl": null,
      "timestamp": "2024-01-15T10:30:00Z",
      "reactions": [],
      "assignee": null,
      "voiceTranscription": null
    }
  ],
  "pagination": {
    "totalMessages": 150,
    "currentPage": 1,
    "totalPages": 15,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

​
Message Sender Types

TypeDescription
user-whatsappMessage from the end user
bot-whatsappAutomated bot response
human-whatsappMessage from a human agent
systemSystem notification or message

​
Message Status

StatusDescription
sentMessage sent successfully
deliveredMessage delivered to recipient
readMessage read by recipient
failedMessage failed to send

​
Next Steps

API Reference

Complete endpoint documentation

Conversations Endpoint

Full endpoint documentation with all parameters

Contact Management

Learn about contact management capabilities

Advanced Usage

Complete guide with code examples and best practices

​
Troubleshooting

  • Verify bearer token is valid and not expired
  • Check that token is properly formatted in Authorization header
  • Ensure tenant ID matches your account
  • Verify the WhatsApp number format (include country code)
  • Check that conversations exist for the specified number
  • Ensure your WhatsApp is connected in the dashboard
  • Use page parameter starting from 1
  • Combine with limit to control results per page
  • Check hasNextPage to determine if more pages exist