Get conversation messages

Retrieve the transcript messages for a conversation

GET /organizations/{organization_id}/projects/{project_id}/conversations/{conversation_id}/messages

cURL

curl -G "https://backend.botcadence.com/organizations/ORG_ID/projects/PROJECT_ID/conversations/CONV_ID/messages" \
  -H "X-API-Key: bot_live_YOUR_KEY" \
  --data-urlencode "skip=0" \
  --data-urlencode "limit=100"

const params = new URLSearchParams({ skip: "0", limit: "100" });

const response = await fetch(
  `https://backend.botcadence.com/organizations/${organizationId}/projects/${projectId}/conversations/${conversationId}/messages?${params}`,
  { headers: { "X-API-Key": process.env.BOTCADENCE_API_KEY } }
);

import os
import requests

response = requests.get(
    f"https://backend.botcadence.com/organizations/{organization_id}/projects/{project_id}/conversations/{conversation_id}/messages",
    headers={"X-API-Key": os.environ["BOTCADENCE_API_KEY"]},
    params={"skip": 0, "limit": 100},
)

200

{
  "status": "success",
  "message": "Conversation messages retrieved successfully",
  "data": {
    "messages": [
      {
        "_id": "665f20000000000000000001",
        "role": "assistant",
        "content": "Hi Alex, thanks for taking my call.",
        "created_at": "2026-07-21T15:04:05Z"
      },
      {
        "_id": "665f20000000000000000002",
        "role": "user",
        "content": "Sure, what's this about?",
        "created_at": "2026-07-21T15:04:12Z"
      }
    ],
    "conversation": {
      "_id": "665f1a2b3c4d5e6f7a8b9c0d",
      "status": "completed",
      "customer_profile_id": "665e00000000000000000001"
    }
  },
  "status_code": 200
}

Returns transcript messages for chat, web voice, and voice conversations, plus conversation metadata (including session timing).

Authentication

X-API-Key · string · required

Project API key for this organization and project. Format: bot_live_…

Path parameters

organization_id · string · required

Organization ID. Must match the API key.

project_id · string · required

Project ID. Must match the API key.

conversation_id · string · required

Conversation ID.

Query parameters

skip · integer · default: "0"

Number of messages to skip.

limit · integer

Maximum messages to return (1–1000). Omit to return all remaining messages after skip.

Response

messages · array · required

Ordered transcript messages (includes agent details when available).

conversation · object · required

Conversation metadata, including session timing and handover summary fields when present.

Errors

400 · Bad Request

Invalid project or conversation ID format.

401 · Unauthorized

Missing, invalid, or revoked API key.

403 · Forbidden

API key is not authorized for this organization or project.

404 · Not Found

Conversation not found.

cURL

curl -G "https://backend.botcadence.com/organizations/ORG_ID/projects/PROJECT_ID/conversations/CONV_ID/messages" \
  -H "X-API-Key: bot_live_YOUR_KEY" \
  --data-urlencode "skip=0" \
  --data-urlencode "limit=100"

const params = new URLSearchParams({ skip: "0", limit: "100" });

const response = await fetch(
  `https://backend.botcadence.com/organizations/${organizationId}/projects/${projectId}/conversations/${conversationId}/messages?${params}`,
  { headers: { "X-API-Key": process.env.BOTCADENCE_API_KEY } }
);

import os
import requests

response = requests.get(
    f"https://backend.botcadence.com/organizations/{organization_id}/projects/{project_id}/conversations/{conversation_id}/messages",
    headers={"X-API-Key": os.environ["BOTCADENCE_API_KEY"]},
    params={"skip": 0, "limit": 100},
)

200

{
  "status": "success",
  "message": "Conversation messages retrieved successfully",
  "data": {
    "messages": [
      {
        "_id": "665f20000000000000000001",
        "role": "assistant",
        "content": "Hi Alex, thanks for taking my call.",
        "created_at": "2026-07-21T15:04:05Z"
      },
      {
        "_id": "665f20000000000000000002",
        "role": "user",
        "content": "Sure, what's this about?",
        "created_at": "2026-07-21T15:04:12Z"
      }
    ],
    "conversation": {
      "_id": "665f1a2b3c4d5e6f7a8b9c0d",
      "status": "completed",
      "customer_profile_id": "665e00000000000000000001"
    }
  },
  "status_code": 200
}