List chat messages

Get a list of messages for a chat

get

Supports filtering, sorting, and pagination via query string parameters.

Path parameters

chatIdstringRequired

The chat ID.

Responses

200

OK

application/json

get/public/v1/helpdesk/chats/{chatId}/messages

HTTPcURLJavaScriptPython

GET /public/v1/helpdesk/chats/{chatId}/messages HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*

200

OK

{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-08-08T16:30:00.546Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-08-08T16:30:00.546Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "deleted": {
          "at": "2026-08-08T16:30:00.546Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "madePublic": {
          "at": "2026-08-08T16:30:00.546Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "madePrivate": {
          "at": "2026-08-08T16:30:00.546Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "revision": 1,
      "chat": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1,
        "type": "Direct"
      },
      "sender": {
        "id": "text",
        "revision": 1,
        "muted": true,
        "status": "Active"
      },
      "content": "text",
      "visibility": "Public",
      "isDeleted": true,
      "links": [
        {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1,
          "message": "[Circular Reference]",
          "uri": "text",
          "objectId": "text"
        }
      ],
      "identity": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      },
      "replyTo": {
        "id": "text",
        "revision": 1,
        "content": "text",
        "visibility": "Public",
        "isDeleted": true
      }
    }
  ]
}