GET/hyax-api/v1/chats

List chats

Team-admin view of support conversations. Only chats with at least one non-internal message are returned.

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Query parameters

Name	Required	Description
limit	No	Default 50, max 100
offset	No	Default 0
status	No	`OPEN` \| `PENDING` \| `RESOLVED` \| `CLOSED`
channel	No	`INTERNAL` \| `WIDGET` \| `API`
assignedToId	No	Filter by assigned team member user ID
unassigned	No	`true` — only unassigned chats
search	No	Search subject, guest name, or email

Request examples

Same request in cURL, Node.js (fetch), and PHP (ext-curl).

curl -X GET 'https://platform.hyax.com/hyax-api/v1/chats?limit=10&offset=0' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": [
    {
      "id": "clx…",
      "subject": "Billing question",
      "status": "OPEN",
      "channel": "WIDGET",
      "name": "Ada",
      "email": "[email protected]",
      "lastMessage": "Can you help with my invoice?",
      "lastMessageSenderType": "PEOPLE",
      "lastMessageAt": "2025-01-15T12:00:00.000Z",
      "unreadCount": 1,
      "type": "widget"
    }
  ],
  "pagination": { "limit": 50, "offset": 0, "total": 1, "hasMore": false }
}