Get Accounts

A Plex server can multiple accounts setup. Additional accounts can be used to help control the content that specified users can stream from the Plex server. For example, a Kids account can only access content appropriate for their age group.

Different accounts can be setup from the Plex administration site, as well as the content filter. The API command described here can return the information for each account setup on the Plex server.

URL

GET http://[IP address]:32400/accounts/?X-Plex-Token=[PlexToken]

Parameters

NameDescription
IP addressThe IP address of the Plex Media server.
PlexTokenThe temporary authentication Plex token.

Return Status

HTTP CodeDescription
200Success - The request was successful.
401Unauthorized - The Plex token provided was not valid.

Response

XML string value that lists the accounts that have been created on the Plex server. An example of the XML returned from the request is shown below:

<?xml version="1.0" encoding="UTF-8"?>
<MediaContainer size="3" identifier="com.plexapp.system.accounts">
    <Account id="0" key="/accounts/0" name="" defaultAudioLanguage="en" autoSelectAudio="1" defaultSubtitleLanguage="en" subtitleMode="1" thumb="" />
    <Account id="1" key="/accounts/1" name="PlexUser" defaultAudioLanguage="en" autoSelectAudio="0" defaultSubtitleLanguage="en" subtitleMode="0" thumb="" />
    <Account id="3972737" key="/accounts/3972737" name="Kids" defaultAudioLanguage="en" autoSelectAudio="0" defaultSubtitleLanguage="en" subtitleMode="0" thumb="" />
</MediaContainer

Remarks

The XML returned provides a list of the libraries that are available on the Plex server. The root is the MediaContainer element. This element contains a few attributes that provide overall information about the accounts on the server.

MediaContainer Attributes for Plex Accounts
AttributeDescription
sizeThe number of accounts available on the Plex server.
identifierThe identifier for this type of item in Plex.

Within the MediaContainer there are one or more Account child elements. Each Account element represents one account on the Plex server.

Plex Account Attributes
AttributeDescription
idAn integer value representing the unique identifier for the account.
keyThe relative URL of the account used to get information about the account.
nameThe name of the account.
defaultAudioLanguageThe default audio language used for the account.
autoSelectAudio1 - automatically select the audio for the account.
0 - do not automatically select the audio for the account.
defaultSubtitleLanguageThe default language for subtitles.
subtitleModeAn integer value representing the subtitle mode. The values are unknown.
thumbThumbnail associated with the account.

Examples

Example 1

Get the list and information for all accounts on the Plex Media Server located at the IP address of 192.168.1.4:

GET http://192.168.1.4:32400/accounts/?X-Plex-Token=L6vkd7JtLHjsH5987vYY