Skip to main content
GET
Get the InboxKit connection state

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Successful Response

Always-200 connection state.

"Not connected" is an ordinary state the dialog branches on, not an error — answering it with a 404 would be indistinguishable from a transient failure on the client, and a transient failure must never present the connect form over a working connection.

connected
boolean
required
connection
InboxkitConnectionReadSchema · object | null
required
active_import_run
InboxkitImportRunReadSchema · object | null