GET
/
user

Authorizations

X-Plex-Token
string
headerrequired

Plex Authentication Token

Response

200 - application/json
adsConsent
boolean | null
required

Unknown

adsConsentReminderAt
string | null
required

Unknown

adsConsentSetAt
string | null
required

Unknown

anonymous
boolean | null
default: falserequired

Unknown

authToken
string
required

The account token

backupCodesCreated
boolean
default: falserequired

If the two-factor authentication backup codes have been created

confirmed
boolean
default: falserequired

If the account has been confirmed

country
string
required

The account country

email
string
required

The account email address

emailOnlyAuth
boolean
default: falserequired

If login with email only is enabled

experimentalFeatures
boolean
default: falserequired

If experimental features are enabled

friendlyName
string
required

Your account full name

entitlements
string[]
required

List of devices your allowed to use with this account

guest
boolean
default: falserequired

If the account is a Plex Home guest user

hasPassword
boolean
default: truerequired

If the account has a password

home
boolean
default: falserequired

If the account is a Plex Home user

homeAdmin
boolean
default: falserequired

If the account is the Plex Home admin

homeSize
integer
required

The number of accounts in the Plex Home

id
integer
required

The Plex account ID

joinedAt
integer
required

Unix epoch datetime in seconds

locale
string | null
required

The account locale

mailingListActive
boolean
default: falserequired

If you are subscribed to the Plex newsletter

mailingListStatus
enum<string>
required

Your current mailing list status

Available options:
active,
unsubscribed
maxHomeSize
integer
required

The maximum number of accounts allowed in the Plex Home

pin
string
deprecated

[Might be removed] The hashed Plex Home PIN

profile
object
required
protected
boolean
default: falserequired

If the account has a Plex Home PIN enabled

rememberExpiresAt
integer
required

Unix epoch datetime in seconds

restricted
boolean
default: falserequired

If the account is a Plex Home managed user

roles
string[]

[Might be removed] List of account roles. Plexpass membership listed here

scrobbleTypes
string
required

Unknown

services
object[]
required
subscription
object
required

If the account’s Plex Pass subscription is active

subscriptionDescription
string | null
required

Description of the Plex Pass subscription

subscriptions
object[]
required
thumb
string
required

URL of the account thumbnail

title
string
required

The title of the account (username or friendly name)

twoFactorEnabled
boolean
default: falserequired

If two-factor authentication is enabled

username
string
required

The account username

uuid
string
required

The account UUID

attributionPartner
string | null
required
Get Source Connection InformationGet User Sign In Data