HappHapp Docs
Chats

Get all conversations with optional filtering

GET
/api/chats

Authorization

access-token
X-Access-Token<token>

Enter your Access Token (format: happ_...)

In: header

Query Parameters

skip?number

Number of items to skip for pagination

take?number

Number of items to return

companyId?string

Filter by company ID

Formatuuid
messenger?string

Filter by messenger channel

Value in

  • "instagram"
  • "telegram"
  • "telegram-bot"
  • "messenger"
  • "whatsapp"
  • "whatsapp-business"
  • "viber-echat"
  • "custom-messenger"
  • "widget"
  • "playground"
search?string

Free-text search over chat names

fromId?string

Filter by messenger-specific sender ID

assistantId?string

Filter by assigned assistant ID

Formatuuid
include?string

Comma-separated list of relations to include in the response

unread?string

Filter by unread state: "true" — only chats with unread messages, "false" — only fully read chats

isUnderAiControl?string

Filter by AI control: "true" — only chats handled by AI, "false" — only chats handled by humans

managerId?string

Filter by assigned manager: a user UUID, "me" (current user), or "null" (chats without a manager)

Response Body

application/json

curl -X GET "https://example.com/api/chats"
{  "data": [    {}  ],  "totalCount": 0,  "page": {}}
Empty
Empty