Skip to main content
GET
/
butler
PlexPHP
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->butler->getButlerTasks(

);

if ($response->object !== null) {
    // handle response
}
{
  "ButlerTasks": {
    "ButlerTask": [
      {
        "description": "<string>",
        "enabled": true,
        "interval": 123,
        "name": "<string>",
        "scheduleRandomized": true,
        "title": "<string>"
      }
    ]
  }
}

Authorizations

​
X-Plex-Token
string
header
required

The token which identifies the user accessing the PMS. This can be either:

  • A traditional access token obtained from plex.tv
  • A JWT token obtained through the JWT authentication flow

JWT tokens provide better security with:

  • Short-lived tokens (7 days expiration)
  • Public-key cryptography (ED25519)
  • Better clock synchronization
  • Individual device revocation capability

Response

200 - application/json

Butler tasks

​
ButlerTasks
object