GET
/
v1
/
chat
/
messages
curl --request GET \
  --url https://api.botpress.cloud/v1/chat/messages
{
  "messages": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "type": "<string>",
      "payload": {},
      "direction": "incoming",
      "userId": "<string>",
      "conversationId": "<string>",
      "tags": {}
    }
  ],
  "meta": {
    "nextToken": "<string>"
  }
}

Query Parameters

​
nextToken
string

Provide the meta.nextToken value provided in the last API response to retrieve the next page of results

​
conversationId
string

Conversation id

​
tags
object

Filter by tags

Response

200
application/json
Returns a list of [Message](#schema_message) objects.
​
messages
object[]
required

The Message object represents a message in a Conversation for a specific User.

​
meta
object
required

Was this page helpful?

Suggest editsRaise issue