GET
/
companions
declare(strict_types=1);

require 'vendor/autoload.php';

use LukeHagar\Plex_API;

$sdk = Plex_API\PlexAPI::builder()
    ->setSecurity(
        '<YOUR_API_KEY_HERE>'
    )
    ->build();



$response = $sdk->plex->getCompanionsData(

);

if ($response->responseBodies !== null) {
    // handle response
}
[
  {
    "identifier": "tv.plex.sonos",
    "baseURL": "https://sonos.plex.tv",
    "title": "Sonos",
    "linkURL": "https://sonos.plex.tv/link",
    "provides": "client,player",
    "token": "<string>"
  }
]

Authorizations

​
X-Plex-Token
string
header
required

Plex Authentication Token

Response

200
application/json
Companions Data
​
identifier
string
required
Example:

"tv.plex.sonos"

​
baseURL
string
required
Example:

"https://sonos.plex.tv"

​
title
string
required
Example:

"Sonos"

​
linkURL
string
required
Example:

"https://sonos.plex.tv/link"

​
provides
string
required
Example:

"client,player"

​
token
string
required

The plex authtoken used to identify with

Stop a single Butler taskGet list of friends of the user logged in