List chats
/chatsList all unique conversations for the organization, sorted by most recent message.
Headers
AuthorizationRequiredstringYour API key, sent as a bearer token: Authorization: Bearer <api_key>. Editing this stays in sync with the API key box on the right.
Query parameters
limitoptionalintegerMaximum number of items to return in a single response. Must be between 1 and 200; defaults to 50. Use together with offset to page through large result sets.
offsetoptionalintegerNumber of items to skip before returning results. Combine with limit for page-based pagination (e.g. offset=50&limit=50 returns the second page). Defaults to 0.
qoptionalstringSearch query (matches phone/email or contact name)
sortoptionalstringSort order
"recent""oldest"Returns
chatsoptionalChat[]
chatsoptionalChat[]Array of Chat
idoptionalstringChat identifier (phone number, email, or group ID)
typeoptionalstring"phone""email""group"is_groupoptionalbooleanWhether this is a group chat
group_idoptionalstring | nullGroup ID (only for group chats)
group_nameoptionalstring | nullGroup name (only for group chats)
member_countoptionalintegerNumber of members (only for group chats)
contactoptionalobject | nullContact info (only for non-group chats)
contactoptionalobject | nullContact info (only for non-group chats)
contact_idoptionalstringnameoptionalstring | nullidentifieroptionalstringmessage_countoptionalintegerinbound_countoptionalintegeroutbound_countoptionalintegerbackground_urloptionalstring | nullPublic URL of the chat background image (if one has been set via the API)
background_idoptionalstring | nullIdentifier for the active chat background
last_message_timeoptionalintegerlast_inbound_timeoptionalinteger | nulllast_outbound_timeoptionalinteger | nulllast_messageoptionalLastMessage
last_messageoptionalLastMessagemessage_idoptionalstringtextoptionalstring | nulldirectionoptionalstring"inbound""outbound"time_sentoptionalintegerpaginationoptionalPagination
paginationoptionalPaginationlimitoptionalintegeroffsetoptionalintegertotaloptionalintegerResponse codes
Sends a live request with your values and shows the real response below. Your key is stored only in this browser.
curl -X GET https://api.blooio.com/v2/api/chats?limit=50&offset=0&q=string&sort=recent \ -H "Authorization: Bearer bl_live_..."{ "chats": [ { "id": "chat_a1b2c3d4", "type": "phone", "is_group": true, "group_id": "grp_a1b2c3d4", "group_name": "string", "member_count": 3, "contact": { "contact_id": "ct_a1b2c3d4", "name": "Jane Doe", "identifier": "+15551234567" }, "message_count": 3, "inbound_count": 3, "outbound_count": 3, "background_url": "https://example.com", "background_id": "chat_a1b2c3d4", "last_message_time": 0, "last_inbound_time": 0, "last_outbound_time": 0, "last_message": { "message_id": "msg_a1b2c3d4", "text": "Hello from Blooio!", "direction": "inbound", "time_sent": 0 } } ], "pagination": { "limit": 50, "offset": 1, "total": 3 }}