Skip to main content
Version: Next

UserPrivateInfo

A user account.

The private fields are only populated for GET /v2/users/me, which needs a token; the public endpoint returns the username and profile alone.

Hierarchy

  • Omit<Schemas[UserPrivateInfo], keyof UserPrivateInfoRePointed>
  • UserPrivateInfoRePointed
    • UserPrivateInfo

Index

Properties

Properties

optionalinheritedcreatedAt

createdAt?: Date

Format: date-time

2022-11-29T14:48:29.381Z

optionalinheritedeffectivePlatformFeatures

effectivePlatformFeatures?: EffectivePlatformFeatures

optionalinheritedemail

email?: null | string

Format: email

bob@example.com

Primary email of the user. It is null when the email is not verified.

optionalinheritedid

id?: string
YiKoxjkaS9gjGTqhF

optionalinheritedisPaying

isPaying?: boolean
true

optionalinheritedorganizationOwnerUserId

organizationOwnerUserId?: null | string
wRsJZtadYvn4mBZmm

ID of the user who owns the organization. Present only for organization accounts.

optionalinheritedplan

plan?: UserPlan

optionalinheritedprofile

profile?: UserProfile

optionalinheritedproxy

proxy?: ProxyResource

inheritedusername

username: string
myusername
Page Options