List visitor notes

GET

/api/v1/visitors/{visitor_id}/notes

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

Required scopes: conversation_read, visitor_notes_read, contact_read_pii
Data access: message_content, pii, internal_notes
MCP tool: visitor_notes

Read a bounded descending page of active stored visitor notes, including notes from website-owned visitors linked through an active contact, without AI eligibility. Requires unrestricted policy and notes, content and PII access. Attachments and reminders are excluded.

Authorizations

installation_token
oauth_client_credentials
conversation_read visitor_notes_read contact_read_pii

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.

limit

integer

>= 1 <= 100

cursor

Continue before the last delivered positive native note ID; maximum is 2147483647. The selected visitor and current website policy remain authoritative.

string

<= 10 characters /^[1-9][0-9]{0,9}$/

Responses

200

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

application/json

object

data

required

object

visitor_id

required

string

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

notes

required

Array<object>

<= 100 items

object

required

string

<= 10 characters /^[1-9][0-9]{0,9}$/

note_id

required

integer

>= 1 <= 2147483647

text

required

Any of:

string
null

string

<= 32768 characters

title

required

Any of:

string
null

string

<= 240 characters

author

required

Any of:

string
null

string

<= 120 characters

created_at

required

Any of:

string
null

string format: date-time

<= 40 characters

text_truncated

required

boolean

next_cursor

required

Any of:

string
null

string

<= 10 characters /^[1-9][0-9]{0,9}$/

coverage

required

Allowed value: persisted_visitor_notes

Example

{
  "data": {
    "coverage": "persisted_visitor_notes"
  }
}

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.