curl --request GET \
--url https://api.flowiq.live/conversations \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.flowiq.live/conversations"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.flowiq.live/conversations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.flowiq.live/conversations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.flowiq.live/conversations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.flowiq.live/conversations")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flowiq.live/conversations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"messages": [
{
"message": "Hello! How can I help you today?",
"sender_type": "bot-whatsapp",
"created_at": "2025-01-10T14:30:00Z",
"message_status": "read",
"media_type": null,
"media_url": null,
"assignee": null,
"voice_note_transcription": null,
"reactions": []
}
],
"pagination": {
"currentPage": 1,
"totalPages": 5,
"totalMessages": 48,
"messagesPerPage": 10,
"hasNextPage": true,
"hasPrevPage": false
},
"count": 1,
"searchTerms": null,
"filtered": false,
"stored": false
}{
"success": false,
"error": "Invalid or missing API key",
"message": "Invalid or missing API key",
"details": "Shopify order not found"
}{
"success": false,
"error": "Authorization required",
"message": "Please provide Authorization bearer token"
}{
"success": false,
"error": "Organization not found",
"message": "Organization not found for API key"
}{
"success": false,
"error": "Internal server error"
}Conversations
Retrieve messages from a conversation with comprehensive filtering and search capabilities.
Default Behavior
- Action: Defaults to
conversation-messagesif not specified - Order: Returns newest messages first (
ascending=false) - Limit: Returns 10 messages per page by default
- Page: Starts at page 1
Search Capabilities
- Text Search: Use
queryparameter with comma-separated terms - Order Search: Use
orderIdto search by Shopify order ID - Combined Search: Use both
queryandorderIdtogether
curl --request GET \
--url https://api.flowiq.live/conversations \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.flowiq.live/conversations"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.flowiq.live/conversations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.flowiq.live/conversations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.flowiq.live/conversations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.flowiq.live/conversations")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flowiq.live/conversations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"messages": [
{
"message": "Hello! How can I help you today?",
"sender_type": "bot-whatsapp",
"created_at": "2025-01-10T14:30:00Z",
"message_status": "read",
"media_type": null,
"media_url": null,
"assignee": null,
"voice_note_transcription": null,
"reactions": []
}
],
"pagination": {
"currentPage": 1,
"totalPages": 5,
"totalMessages": 48,
"messagesPerPage": 10,
"hasNextPage": true,
"hasPrevPage": false
},
"count": 1,
"searchTerms": null,
"filtered": false,
"stored": false
}{
"success": false,
"error": "Invalid or missing API key",
"message": "Invalid or missing API key",
"details": "Shopify order not found"
}{
"success": false,
"error": "Authorization required",
"message": "Please provide Authorization bearer token"
}{
"success": false,
"error": "Organization not found",
"message": "Organization not found for API key"
}{
"success": false,
"error": "Internal server error"
}action query parameter.Available Actions
| Action | Description | Required Parameters |
|---|---|---|
conversation-messages | Get messages from a conversation (default) | whatsappNumber or contactId |
contacts | List all contacts | — |
find-by-phone | Find a contact by phone number | whatsappNumber |
Action: Get Conversation Messages
Fetch messages from a specific conversation. This is the default action.Basic Usage
curl -X GET "https://api.flowiq.live/conversations?whatsappNumber=27123456789" \
-H "Authorization: Bearer YOUR_BEARER_TOKEN"
Paginated Results
curl -X GET "https://api.flowiq.live/conversations?whatsappNumber=27123456789&page=2&limit=20" \
-H "Authorization: Bearer YOUR_BEARER_TOKEN"
Search Messages by Text
curl -X GET "https://api.flowiq.live/conversations?whatsappNumber=27123456789&query=urgent,help" \
-H "Authorization: Bearer YOUR_BEARER_TOKEN"
Search by Shopify Order ID
curl -X GET "https://api.flowiq.live/conversations?whatsappNumber=27123456789&orderId=1234567890" \
-H "Authorization: Bearer YOUR_BEARER_TOKEN"
Action: List Contacts
Retrieve a paginated list of all contacts for your organization.Get All Contacts
curl -X GET "https://api.flowiq.live/conversations?action=contacts" \
-H "Authorization: Bearer YOUR_BEARER_TOKEN"
Paginated Contacts
curl -X GET "https://api.flowiq.live/conversations?action=contacts&page=2&limit=25" \
-H "Authorization: Bearer YOUR_BEARER_TOKEN"
Search Contacts by Name/Phone
curl -X GET "https://api.flowiq.live/conversations?action=contacts&search=john" \
-H "Authorization: Bearer YOUR_BEARER_TOKEN"
Action: Find Contact by Phone
Look up a specific contact using their phone number.curl -X GET "https://api.flowiq.live/conversations?action=find-by-phone&whatsappNumber=27123456789" \
-H "Authorization: Bearer YOUR_BEARER_TOKEN"
+27 12 345 6789 and 27123456789 will find the same contact.Reference Tables
Message Sender Types
| Sender Type | Description |
|---|---|
user-whatsapp | Message sent by the customer via WhatsApp |
bot-whatsapp | Automated bot response |
human-whatsapp | Message sent by a human agent |
system | System-generated message |
Message Status
| Status | Description |
|---|---|
sent | Message has been sent |
delivered | Message has been delivered to recipient |
read | Message has been read by recipient |
failed | Message delivery failed |
Media Types
| Media Type | Description |
|---|---|
image | Image attachment (JPEG, PNG, etc.) |
video | Video attachment |
audio | Audio message or voice note |
document | Document (PDF, DOCX, etc.) |
interactive | Interactive message (buttons, lists) |
Bot Status Values
| Status | Description |
|---|---|
active | Bot is actively responding to this contact |
paused | Bot responses are paused (human takeover) |
null | No bot configured for this contact |
Authorizations
Bearer token for authentication. Format: Bearer YOUR_BEARER_TOKEN
Query Parameters
API action to perform
conversation-messages, contacts, find-by-phone WhatsApp phone number (required for message and find-by-phone actions)
Contact UUID (alternative to whatsappNumber)
Number of items per page (messages: default 10, contacts: default 50)
1 <= x <= 100Page number for pagination
x >= 1Search terms (comma-separated for multiple terms)
Shopify order ID to search for (fetches order number from Shopify)
Message order (false = newest first, true = oldest first)
Search contacts by name/phone (for contacts action)
Response
Successful response
- Option 1
- Option 2
- Option 3
Whether the request was successful
true
Array of conversation messages
Show child attributes
Show child attributes
Number of messages returned in this response
x >= 010
Whether search filtering was applied
true
Show child attributes
Show child attributes
Search terms that were applied (if any)
["#4275", "urgent"]
Whether messages were stored in contact record
false

