GET/hyax-api/v1/chats/:id/messages

Get chat messages

Returns the chat metadata and message thread (includes internal notes).

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
cursor	No	Message ID cursor for older messages

Request examples

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

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

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": {
    "chat": {
      "id": "clx…",
      "subject": "Billing question",
      "status": "OPEN",
      "channel": "WIDGET"
    },
    "messages": [
      {
        "id": "msg…",
        "content": "Can you help with my invoice?",
        "senderType": "PEOPLE",
        "isInternal": false,
        "createdAt": "2025-01-15T12:00:00.000Z"
      }
    ],
    "nextCursor": null
  }
}