mirror of
https://github.com/LukeHagar/plexphp.git
synced 2025-12-09 12:37:47 +00:00
19 lines
5.4 KiB
Markdown
19 lines
5.4 KiB
Markdown
# Friend
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
|
|
| `email` | *string* | :heavy_check_mark: | The account email address | username@email.com |
|
|
| `home` | *bool* | :heavy_check_mark: | If the account is a Plex Home user | |
|
|
| `id` | *int* | :heavy_check_mark: | The Plex account ID | |
|
|
| `sharedServers` | array<[Operations\SharedServers](../../Models/Operations/SharedServers.md)> | :heavy_check_mark: | N/A | |
|
|
| `sharedSources` | array<[Operations\SharedSources](../../Models/Operations/SharedSources.md)> | :heavy_check_mark: | N/A | |
|
|
| `status` | [Operations\Status](../../Models/Operations/Status.md) | :heavy_check_mark: | Current friend request status | accepted |
|
|
| `thumb` | *string* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578 |
|
|
| `title` | *string* | :heavy_check_mark: | The title of the account (username or friendly name) | username123 |
|
|
| `username` | *string* | :heavy_check_mark: | The account username | username123 |
|
|
| `uuid` | *string* | :heavy_check_mark: | The account Universally Unique Identifier (UUID) | 7d1916e0d8f6e76b |
|
|
| `friendlyName` | *string* | :heavy_check_mark: | The account full name | exampleUser |
|
|
| `restricted` | *?bool* | :heavy_minus_sign: | If the account is a Plex Home managed user | | |