GET
/
v1
/
chat
/
messages
cURL
curl --request GET \
  --url https://api.botpress.cloud/v1/chat/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'x-bot-id: <api-key>'
{
  "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>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

x-bot-id
string
header
required

Your bot ID.

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 objects.

messages
object[]
required
meta
object
required