Get
/api/v1/livechat/visitor/{token}
Get the details of a specific visitor.
The response may include externalIds when the visitor has been linked to an external system by an omnichannel app.
Changelog
| Version | Description |
|---|---|
| 8.4.0 | Added externalIds field to the visitor response. |
Path parameters
token
stringRequired
The visitor token.
Responses
200
Success Example
{
"visitor": {
"_id": "6a22b1765528fa64dd29de70",
"username": "guest-10",
"_updatedAt": "2026-06-05T11:22:30.665Z",
"token": "test-token-12345",
"phone": [
{
"phoneNumber": "+15551234567"
}
],
"visitorEmails": [
{
"address": "postman-test@example.com"
}
],
"name": "Postman Test Visitor"
},
"success": true
}object
visitor
object
_id
string
username
string
_updatedAt
string
token
string
phone
Array of object
object
phoneNumber
string
visitorEmails
Array of object
object
address
string
name
string
livechatData
object
address
string
externalIds
Array of object
Channel-specific external identifiers (e.g. WhatsApp BSUID). Set by omnichannel apps via apps-engine, not through this REST endpoint's request body.
object
appId
string
ID of the omnichannel app that registered this identifier.
entityId
string
External identifier value (e.g. Meta BSUID).
metadata
object
Optional app-specific metadata (e.g. WhatsApp username).
success
boolean