listMessages

Retrieves a list of Message you’ve previously created. The messages are returned in sorted order, with the most recent appearing first. The list can be filtered using Tags.

GET/v1/chat/messages

Authorization

AuthorizationBearerrequired

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

Header parameters

x-bot-idstringrequired

Bot id

x-integration-idstring

Integration id

x-integration-aliasstring

Integration alias

Query parameters

nextTokenstring

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

conversationIdstring

Conversation id

tagsobject

Filter by tags

afterDatestring

Date in ISO 8601 string with UTC timezone after which the message was created (inclusive)

beforeDatestring

Date in ISO 8601 string with UTC timezone before which the message was created (inclusive)

Response

Returns a list of Message objects.

messagesobject[]required

metaobjectrequired

Request

curl --request GET \ \
  --url https://api.botpress.cloud/v1/chat/messages \
  --header 'x-bot-id: <x-bot-id>' \
  --header 'Authorization: Bearer <token>'

Response

{
  "messages": [
    {
      "id": "string",
      "createdAt": "2025-01-15T12:00:00Z",
      "updatedAt": "2025-01-15T12:00:00Z",
      "type": "string",
      "payload": {},
      "direction": "incoming",
      "userId": "string",
      "conversationId": "string",
      "tags": {
        "key": "string"
      },
      "origin": "synthetic"
    }
  ],
  "meta": {
    "nextToken": "string"
  }
}