Get a visitor

GET

/api/v1/dashboard/visitors/{visitor_id}

const url = 'https://api.inside.chat/api/v1/dashboard/visitors/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.inside.chat/api/v1/dashboard/visitors/example \
  --header 'Authorization: Bearer <token>'

Required scopes: conversation_read
Data access: –
MCP tool: visitor

Read stored visitor identity and optional nickname without requiring AI activity. Unrestricted installation policy required. Nickname requires PII permission and scope; contact enrichment, tracking and live state are excluded.

Authorizations

installation_token
oauth_client_credentials
conversation_read

Parameters

Path Parameters

visitor_id

required

string

/^vis_[0-9]{1,20}_[1-9][0-9]{0,18}_[1-9][0-9]{0,18}$/

Query Parameters

website_id

string

/^web_[0-9]{1,20}_[1-9][0-9]{0,18}$/

Optional; if present must match the resource owner.

Responses

200

Authorized result. Projection depends on current scopes and data policy.

application/json

object

data

required

object

visitor

required

object

required

string

<= 100 characters /^vis_[0-9]{1,20}_[1-9][0-9]{0,18}_[1-9][0-9]{0,18}$/

nickname

required

Any of:

string
null

string

<= 200 characters

coverage

required

Allowed value: persisted_visitor_metadata

Example

{
  "data": {
    "coverage": "persisted_visitor_metadata"
  }
}

400

Invalid, duplicate or unsupported request parameters.

401

Missing, expired or revoked installation credential.

404

Resource not found or not permitted by current authority.

422

The requested capability is not available for application installations.

429

Per-app quota exceeded.

Headers

Retry-After

integer

>= 1

503

Enrollment, native service or required authority is unavailable.