getConversation

Retrieves the Conversation object for a valid identifier.

GET/conversations/{id}

Header parameters

x-user-keystringrequired

Authentication Key

Path parameters

idstringrequired

Conversation id

Response

application/json

Returns a Conversation object if a valid identifier was provided

The response is of type getConversationResponse · object.

conversationobjectrequired

Request

curl --request GET \ \
  --url https://chat.botpress.cloud/your_default_webhook_url/conversations/{id} \
  --header 'x-user-key: <x-user-key>' \
  --header 'Authorization: Bearer <token>'

Response

{
  "conversation": {
    "id": "string",
    "createdAt": "2025-01-15T12:00:00Z",
    "updatedAt": "2025-01-15T12:00:00Z"
  }
}