v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

List Messages

This API endpoint retrieves a list of messages in a given Message Channel. Messages are paginated and returned in descending chronological order.

get/v1/messages

Query parameters

channelIdstring required

The Message Channel to retrieve messages from.

nextTokenstring

limitinteger

Response

200

nextTokenstring

Example response

{
  "data": [
    {
      "id": "fbd5a90b-5216-4230-bcd2-0d6a746aeb65",
      "object": "message",
      "senderId": "1dbb3e36-af70-4f41-89e6-6ddf9e2c62b5",
      "createdAt": "2023-08-07T15:11:13.549092588Z",
      "updatedAt": "2023-08-07T15:11:13.549092588Z",
      "channelId": "602f5afd-2a42-47a4-a5e0-c3db0adf966a",
      "text": "This is an **urgent** message! My favorite client portal is [Copilot](https://copilot.app).",
      "isAttachmentIncluded": true
    }
  ],
  "nextToken": "eyJwa2V5IjoiMmUxOTBhYmUtZDZhZC00ZTcwLWE5ZDUtNzYwZTNlZDQ5OTg1Iiwic2tleSI6IkNMSUVOVF9VU0VSIiwiZGF0YSI6InVzLWVhc3QtMV9xbEFSQlE5bUYvMjViMmE2ZTctNzExYy00ZWE3LTgxYmEtNjViYzlkZGYxNWVjLzJlMTkwYWJlLWQ2YWQtNGU3MC1hOWQ1LTc2MGUzZWQ0OTk4NSJ9"
}