Skip to main content
Version: Next

User

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 UserRePointed>
  • UserRePointed
    • User

Index

Properties

Properties

optionalinheritedcreatedAt

createdAt?: Date

Format: date-time

2022-11-29T14:48:29.381Z

optionalinheritedeffectivePlatformFeatures

effectivePlatformFeatures?: EffectivePlatformFeatures

optionalinheritedemail

email?: string

Format: email

bob@example.com

optionalinheritedid

id?: string
YiKoxjkaS9gjGTqhF

optionalinheritedisPaying

isPaying?: boolean
true

optionalinheritedplan

plan?: UserPlan

optionalinheritedprofile

profile?: UserProfile

optionalinheritedproxy

proxy?: UserProxy

inheritedusername

username: string
myusername
Page Options