Skip to main content
GET
Get the visitor conversation

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

The visitor's current conversation in this inbox. There is one at a time, which is why these routes are singular.

id
integer

The conversation display ID.

inbox_id
integer

The web-widget inbox.

contact_last_seen_at
integer

Unix epoch seconds of the visitor's last read. 0 when they have never read it.

status
string

open, resolved or pending.