Retrieve information for a Livechat visitor by ID.
Permission required: view-l-room
The response does not include the visitor token. To obtain a token, register or update the visitor using Register a New Livechat Visitor, which returns the token in the response.
The response may include externalIds when the visitor has been linked to an external system by an omnichannel app (e.g. WhatsApp BSUID). This field cannot be set through REST registration endpoints.
Changelog
| Version | Description |
|---|---|
| 8.5.0 | The token field is no longer returned in the response. Retrieve the token from the visitor registration endpoint instead. |
| 8.4.0 | Added externalIds field to the visitor response. |
The authToken of the authenticated user.
The userId of the authenticated user.
The visitor ID.
OK
{
"visitor": {
"_id": "6a22b1765528fa64dd29de70",
"username": "guest-10",
"status": "online",
"ts": "2026-06-05T11:22:30.664Z",
"_updatedAt": "2026-06-05T11:22:30.665Z",
"name": "Postman Test Visitor",
"phone": [
{
"phoneNumber": "+15551234567"
}
],
"visitorEmails": [
{
"address": "postman-test@example.com"
}
]
},
"success": true
}Channel-specific external identifiers (e.g. WhatsApp BSUID). Set by omnichannel apps via apps-engine, not through this REST endpoint's request body.
ID of the omnichannel app that registered this identifier.
External identifier value (e.g. Meta BSUID).
Optional app-specific metadata (e.g. WhatsApp username).
Bad Request
{
"success": false,
"error": "must have required property 'visitorId' [invalid-params]",
"errorType": "invalid-params"
}{
"success": false,
"error": "visitor-not-found"
}Unauthorized
{
"status": "error",
"message": "You must be logged in to do this."
}Forbidden
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}{
"success": false,
"error": "unauthorized"
}