> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Visitor Information by ID
> 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. |
## OpenAPI
````json GET /api/v1/livechat/visitors.info
{
"openapi": "3.0.0",
"info": {
"version": "1.0.0",
"title": "Omnichannel"
},
"servers": [
{
"url": "https://apiexplorer.support.rocket.chat"
}
],
"tags": [
{
"name": "Omnichannel Users"
},
{
"name": "Omnichannel Agents"
},
{
"name": "Omnichannel Monitors"
},
{
"name": "Omnichannel Visitors"
},
{
"name": "Omnichannel Contacts"
},
{
"name": "Omnichannel Rooms"
},
{
"name": "Omnichannel Departments"
},
{
"name": "Omnichannel Custom Fields"
},
{
"name": "Omnichannel Business Hours"
},
{
"name": "Omnichannel Priorities"
},
{
"name": "Omnichannel Tags"
},
{
"name": "Omnichannel Units"
},
{
"name": "SLA Policies"
},
{
"name": "Canned Responses"
},
{
"name": "Omnichannel Transcript"
},
{
"name": "Omnichannel Statistics"
},
{
"name": "Omnichannel Agent Stats"
},
{
"name": "Omnichannel Dashboards"
},
{
"name": "Reports"
},
{
"name": "Omnichannel Inquiries"
},
{
"name": "Omnichannel Webhooks"
},
{
"name": "Livechat"
},
{
"name": "Livechat Appearance"
},
{
"name": "Livechat Triggers"
},
{
"name": "Livechat Messages"
},
{
"name": "Livechat Page Visited"
}
],
"paths": {
"/api/v1/livechat/visitors.info": {
"parameters": [],
"get": {
"summary": "Get Visitor Information by ID",
"operationId": "get-api-v1-livechat-visitor.info",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"visitor": {
"type": "object",
"properties": {
"_id": {
"type": "string"
},
"username": {
"type": "string"
},
"status": {
"type": "string"
},
"ts": {
"type": "string"
},
"_updatedAt": {
"type": "string"
},
"name": {
"type": "string"
},
"phone": {
"type": "array",
"items": {
"type": "object",
"properties": {
"phoneNumber": {
"type": "string"
}
}
}
},
"visitorEmails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string"
}
}
}
},
"department": {
"type": "string"
},
"externalIds": {
"type": "array",
"description": "Channel-specific external identifiers (e.g. WhatsApp BSUID). Set by omnichannel apps via apps-engine, not through this REST endpoint's request body.",
"items": {
"type": "object",
"properties": {
"appId": {
"type": "string",
"description": "ID of the omnichannel app that registered this identifier."
},
"entityId": {
"type": "string",
"description": "External identifier value (e.g. Meta BSUID)."
},
"metadata": {
"type": "object",
"additionalProperties": "true",
"description": "Optional app-specific metadata (e.g. WhatsApp username)."
}
}
}
}
}
},
"success": {
"type": "boolean"
}
}
},
"examples": {
"Success Example": {
"value": {
"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"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"error": {
"type": "string"
},
"errorType": {
"type": "string"
}
}
},
"examples": {
"Example 1": {
"value": {
"success": "false",
"error": "must have required property 'visitorId' [invalid-params]",
"errorType": "invalid-params"
}
},
"Example 2": {
"value": {
"success": "false",
"error": "visitor-not-found"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/authorizationError"
},
"403": {
"$ref": "#/components/responses/permissionError"
}
},
"description": "Retrieve information for a Livechat visitor by ID.\n\nPermission required: `view-l-room`\n\nThe 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.\n\nThe 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.\n\n### Changelog\n| Version | Description |\n| ------- | ----------- |\n| 8.5.0 | The `token` field is no longer returned in the response. Retrieve the token from the visitor registration endpoint instead. |\n| 8.4.0 | Added `externalIds` field to the visitor response. |",
"parameters": [
{
"schema": {
"type": "string"
},
"in": "query",
"name": "visitorId",
"description": "The visitor ID.",
"required": "true"
},
{
"$ref": "#/components/parameters/AuthToken"
},
{
"$ref": "#/components/parameters/UserId"
}
],
"tags": [
"Omnichannel Visitors"
]
}
}
},
"components": {
"responses": {
"authorizationError": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"examples": {
"Authorization Error": {
"value": {
"status": "error",
"message": "You must be logged in to do this."
}
}
}
}
}
},
"permissionError": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"error": {
"type": "string"
}
}
},
"examples": {
"Permission Error": {
"value": {
"success": "false",
"error": "User does not have the permissions required for this action [error-unauthorized]"
}
},
"Unauthorized": {
"value": {
"success": "false",
"error": "unauthorized"
}
}
}
}
}
}
},
"parameters": {
"AuthToken": {
"name": "X-Auth-Token",
"in": "header",
"description": "The `authToken` of the authenticated user.",
"required": "true",
"schema": {
"type": "string"
},
"example": "RScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f"
},
"UserId": {
"name": "X-User-Id",
"in": "header",
"description": "The `userId` of the authenticated user.",
"required": "true",
"schema": {
"type": "string"
},
"example": "rbAXPnMktTFbNpwtJ"
}
}
}
}
````