Skip to content

js-bao-wss-client


js-bao-wss-client / AppInvitationInfo

Interface: AppInvitationInfo ​

An app-level invitation, as returned by invitations.create(), invitations.get(), and each item of invitations.list(). Carries the invitee's email, the assigned role, and the inviteToken used to build an accept-page link.

Properties ​

accepted ​

accepted: boolean


acceptedAt? ​

optional acceptedAt?: string


appId? ​

optional appId?: string


email ​

email: string


expiresAt? ​

optional expiresAt?: string


invitationId ​

invitationId: string


invitedAt ​

invitedAt: string


invitedBy ​

invitedBy: string


inviteToken? ​

optional inviteToken?: string | null

Tokenized accept token — combine with your app's accept-page URL to build a working CTA (e.g. ${baseUrl}/invite/accept?inviteToken=…). null only for legacy rows that have not been upgraded yet — new invitations always have one.


note? ​

optional note?: string | null


role ​

role: string


source? ​

optional source?: string | null


status? ​

optional status?: "pending" | "expired" | "accepted"

Lifecycle status. Returned by invitations.get(). Not present on list responses.

Documentation validated against js-bao-wss-client 3.4.0 · js-bao 0.11.0 · primitive-admin 1.0.62 · primitive-app 3.1.0 — 2026-09-30