Docs
get

Get conversation

Retrieves a complete conversation including messages, visitor information, user details, summary, and localized tags.

Conversations
Endpoint
/conversations/{token}
Method
get
Plan Required
FREE
Authorization
Bearer Token required
Permissions
READ
Content-Type
application/json

API Tester(Loading...)

Loading API token configuration...

Payload

URL Parameters

tokenstringrequired

Conversation token

Query Parameters

langstring

Language code for tag translations (e.g., en, pl, de)

Response

200Conversation with visitor data, summary, and localized tags

conversation

object
Object with 14 properties

messages

array
Array of objects (12 properties each)

visitor

object
Object with 11 properties

users

array
Array of objects (17 properties each)
401Invalid or missing API token
No response details available
404Conversation not found
No response details available

Expected Response

JSON
{
  "conversation": {
    "id": "abc123def456",
    "websiteId": "abc123def456",
    "token": "sk-abc123def456ghi789",
    "rating": 42,
    "assigneeId": "abc123def456",
    "visitorId": "abc123def456",
    "visitorTyping": true,
    "userTyping": true,
    "createdAt": "2024-03-15T14:30:00Z",
    "status": "active",
    "firstMessageAt": "Hello, this is a test message",
    "closedAt": "sample_closedAt",
    "summary": "Customer needs help with billing issue and refund processing",
    "tags": [
      "Billing Issue",
      "Refund Request"
    ]
  },
  "messages": "Hello, this is a test message",
  "visitor": {
    "id": "abc123def456",
    "name": "John Doe",
    "token": "sk-abc123def456ghi789",
    "ip": "sample_ip",
    "context": "Sample text content",
    "websiteId": "abc123def456",
    "country": 10,
    "city": "New York",
    "online": true,
    "createdAt": "2024-03-15T14:30:00Z",
    "updatedAt": "2024-03-15"
  },
  "users": [
    {
      "id": "abc123def456",
      "name": "John Doe",
      "email": "[email protected]",
      "theme": "sample_theme",
      "language": "sample_language",
      "createdAt": "2024-03-15T14:30:00Z",
      "updatedAt": "2024-03-15",
      "avatar": {
        "id": "abc123def456",
        "token": "sk-abc123def456ghi789",
        "url": "https://example.com",
        "name": "John Doe",
        "mimeType": "application/pdf",
        "userId": "abc123def456",
        "websiteId": "abc123def456",
        "createdAt": "2024-03-15T14:30:00Z",
        "updatedAt": "2024-03-15"
      },
      "fileId": "abc123def456",
      "activated": true,
      "fcmTokens": "sk-abc123def456ghi789",
      "selectedWebsiteId": "abc123def456",
      "lastVisitAt": "sample_lastVisitAt",
      "googleId": "abc123def456",
      "gitHubId": "abc123def456",
      "authProvider": "LOCAL",
      "emailVerified": true
    }
  ]
}

API Access Token

Base URL

https://api.5chat.io

Quick Links

Installation GuideWidget ConfigurationAuthenticationContact Support