List visitors linked to a contact

GET

/api/v1/contacts/{contact_id}/visitors

const url = 'https://api.inside.chat/api/v1/contacts/example/visitors';
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/contacts/example/visitors \
  --header 'Authorization: Bearer <token>'

Required scopes: contact_read, contact_read_pii, conversation_read
Data access: pii
MCP tool: contact_visitors

Page stored website-owned visitor IDs linked to a contact, descending. Requires unrestricted policy. Excludes deleted contacts/visitors, live state, profiles and remote CRM associations.

Authorizations

installation_token
oauth_client_credentials
contact_read contact_read_pii conversation_read

Parameters

Path Parameters

contact_id

required

string

/^ctc_[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.

limit

integer

>= 1 <= 100

cursor

string

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

Responses

200

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

application/json

object

data

required

object

data

required

Array<object>

<= 100 items

object

required

string

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

next_cursor

required

Any of:

string
null

string

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

coverage

required

Allowed value: stored_contact_visitor_links

contact_id

required

string

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

Example

{
  "data": {
    "coverage": "stored_contact_visitor_links"
  }
}

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.