Skip to main content
GET
Show embed session

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme

Path Parameters

id
integer
required

The session id returned when it was created.

Response

The session

id
integer

The session id, for reading it back later.

Example:

1

quote_request_id
integer

The quote request the embed was opened on. Yours to keep; you never send it back.

Example:

42

platform
enum<string>

What the session was opened for.

Available options:
web,
webview
embed_url
string

Put this in an iframe or a WebView. Belongs to one customer and expires after an hour.

Example:

"https://.../embed?session=8TJLiR0YhE8ikWSH3N16br2Q4qDg0ozGu18c5c3E"

expires_at
string<date-time>

When the URL stops working.

parent_origin
string | null

The site allowed to frame it. Null for a webview.

Where the app is reopened. Null for the web.

locale
string | null
expired
boolean

Whether the URL has stopped working.

first_opened_at
string<date-time> | null

When the customer first opened it, if they have.