Skip to main content
GET
Get the widget visitor

Authorizations

X-Auth-Token
string
header
required

The signed session token from POST /api/v1/widget/config. Sent alongside website_token in the query string on every widget request. See /api-reference/widget-api-authentication.

Query Parameters

website_token
string
required

The web-widget inbox's public token, as it appears in your widget snippet. Required on every widget request.

Example:

"EXAMPLE_WEBSITE_TOKEN"

Response

Success

Deliberately thin. The widget is told whether it knows the visitor, not what it knows about them — a browser has no business holding the contact record.

id
integer

The contact ID.

has_email
boolean

Whether an email address is on file.

has_name
boolean

Whether a name is on file.

has_phone_number
boolean

Whether a phone number is on file.

identifier
string | null

Your own identifier for the visitor, once set through set_user.