Skip to main content
GET
User status and connections

Authorizations

Authorization
string
header
required

Your API key (vsk_…), issued at onboarding. Keep it server-side.

Query Parameters

userRef
string
required

The identifier you passed to signLink() for this user.

Response

The user's status and connections.

userRef
string
required

Your identifier for the user.

Example:

"user_123"

connected
boolean
required

At least one connection is active.

needsReauth
boolean
required

At least one connection is needs_reauth. Ask the user to reconnect.

recentConversationCount
integer
required

Sum of recentConversationCount over all connections.

Example:

12

historyComplete
boolean
required

Every connection that is not revoked has its whole history imported. False when the user has no connection.

oldestConversationAt
string<date-time> | null
required

Earliest oldestConversationAt over the connections. Null when no conversation is imported.

connections
object[]
required
recentWindowDays
integer
required

Size of the rolling window used for recent counts.

Example:

30