Skip to main content
GET
Read Instagram messages and contacts
This endpoint is prepared for rollout and is not yet deployed.
Read Instagram inbox history and contacts with the same fiq_ API key used for WhatsApp. GET /conversations?platform=instagram is an alias with the same actions and response format.

Available Actions

Get Conversation Messages

Messages are newest first. Set ascending=true for oldest first, or query=hello to find a substring in message text. Only Instagram messages are returned, even for contacts merged with WhatsApp or another channel.

Response (200)

count is the number of messages on this page; totalMessages counts all messages matching the contact and search. Sender types are user-instagram (customer), human-instagram (staff or API) and bot-instagram (automated reply).

List Contacts

Returns success, contacts, count and pagination. Contacts use the same shape as contact above. query searches the Instagram username. Pagination uses totalContacts and contactsPerPage in place of the message fields. Contacts are ordered by their most recent Instagram message, then contact ID.

Find a Contact

Returns success: true and contact. An ID that does not belong to an Instagram contact in your organization returns 404.

Query Parameters

When both recipient identifiers are supplied they must match. The endpoint reads stored history without marking messages as read or fetching earlier Instagram history.

Authorizations

Authorization
string
header
required

Your FlowIQ API key (from Settings → Profile → API Keys), sent as a bearer token. Format: Bearer fiq_YOUR_API_KEY

Query Parameters

action
enum<string>
default:conversation-messages
Available options:
conversation-messages,
contacts,
find-by-instagram
contact_id
string<uuid>
instagram_id
string
limit
integer
default:10

Defaults to 50 for contacts

Required range: 1 <= x <= 100
page
integer
default:1
Required range: 1 <= x <= 1000000
ascending
boolean
default:false

Message ordering; newest first by default

query
string

Substring search in message text, or Instagram username when listing contacts

Response

Messages, contacts or a contact, according to action

success
boolean
contact
object
contacts
object[]
messages
object[]
count
integer
pagination
object

currentPage, totalPages, totalMessages/messagesPerPage (or totalContacts/contactsPerPage), hasNextPage, hasPrevPage