Plex

App · 20 actions

Browse Plex libraries, media, playlists, playback history and active sessions; refresh metadata and mark watched items.

Actions

ActionWhat it does
Delete playlistDelete playlist.
Get identityGet identity.
Get itemGet item.
Get playlistGet playlist.
Get serverGet server.
List clientsList clients.
List item childrenList item children.
List item leavesList item leaves.
List librariesList libraries.
List library itemsList library items.
List on deckList on deck.
List play historyList play history.
List playlist itemsList playlist items.
List playlistsList playlists.
List recently addedList recently added.
List sessionsList sessions.
Mark unwatchedMark unwatched.
Mark watchedMark watched.
Refresh itemRefresh item.
Refresh libraryRefresh library.

Delete playlist

Delete playlist.

Inputs

Playlistplaylist_idtextRequired
Choose the playlist or use an ID from a previous step.

Outputs

datanull
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Get identity

Get identity.

Inputs

None.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "MediaContainer": {
      "claimed": false,
      "machineIdentifier": "example",
      "size": 0,
      "version": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get item

Get item.

Inputs

Item IDitem_idtextRequired
Item id.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "MediaContainer": {
      "Metadata": [],
      "size": 0,
      "totalSize": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get playlist

Get playlist.

Inputs

Playlistplaylist_idtextRequired
Choose the playlist or use an ID from a previous step.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "MediaContainer": {
      "Metadata": [],
      "size": 0,
      "totalSize": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get server

Get server.

Inputs

None.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "MediaContainer": {
      "friendlyName": "example",
      "machineIdentifier": "example",
      "size": 0,
      "version": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

List clients

List clients.

Inputs

None.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "MediaContainer": {
      "Server": [],
      "size": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

List item children

List item children.

Inputs

Item IDitem_idtextRequired
Item id.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "MediaContainer": {
      "Metadata": [],
      "size": 0,
      "totalSize": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

List item leaves

List item leaves.

Inputs

Item IDitem_idtextRequired
Item id.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "MediaContainer": {
      "Metadata": [],
      "size": 0,
      "totalSize": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

List libraries

List libraries.

Inputs

None.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "MediaContainer": {
      "Directory": [],
      "size": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

List library items

List library items. Returns one page; use next_cursor to continue.

Inputs

Librarylibrary_idtextRequired
Choose the library or use an ID from a previous step.
Starting positionoffsetnumber
Number of records to skip. Leave empty to start at the beginning.At least 0.
Results per pagelimitnumber
Maximum records in this page. Leave empty for the service default.From 1 to 200.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "MediaContainer": {
      "Metadata": [],
      "size": 0,
      "totalSize": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

List on deck

List on deck. Returns one page; use next_cursor to continue.

Inputs

Starting positionoffsetnumber
Number of records to skip. Leave empty to start at the beginning.At least 0.
Results per pagelimitnumber
Maximum records in this page. Leave empty for the service default.From 1 to 200.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "MediaContainer": {
      "Metadata": [],
      "size": 0,
      "totalSize": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

List play history

List play history. Returns one page; use next_cursor to continue.

Inputs

Starting positionoffsetnumber
Number of records to skip. Leave empty to start at the beginning.At least 0.
Results per pagelimitnumber
Maximum records in this page. Leave empty for the service default.From 1 to 200.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "MediaContainer": {
      "Metadata": [],
      "size": 0,
      "totalSize": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

List playlist items

List playlist items.

Inputs

Playlistplaylist_idtextRequired
Choose the playlist or use an ID from a previous step.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "MediaContainer": {
      "Metadata": [],
      "size": 0,
      "totalSize": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

List playlists

List playlists. Returns one page; use next_cursor to continue.

Inputs

Starting positionoffsetnumber
Number of records to skip. Leave empty to start at the beginning.At least 0.
Results per pagelimitnumber
Maximum records in this page. Leave empty for the service default.From 1 to 200.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "MediaContainer": {
      "Metadata": [],
      "size": 0,
      "totalSize": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

List recently added

List recently added. Returns one page; use next_cursor to continue.

Inputs

Starting positionoffsetnumber
Number of records to skip. Leave empty to start at the beginning.At least 0.
Results per pagelimitnumber
Maximum records in this page. Leave empty for the service default.From 1 to 200.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "MediaContainer": {
      "Metadata": [],
      "size": 0,
      "totalSize": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

List sessions

List sessions.

Inputs

None.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "MediaContainer": {
      "Metadata": [],
      "size": 0,
      "totalSize": 0
    }
  },
  "has_more": false,
  "next_cursor": null
}

Mark unwatched

Mark unwatched.

Inputs

Item IDitem_idtextRequired
Item id.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Mark watched

Mark watched.

Inputs

Item IDitem_idtextRequired
Item id.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Refresh item

Refresh item.

Inputs

Item IDitem_idtextRequired
Item id.

Outputs

datanull
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Refresh library

Refresh library.

Inputs

Librarylibrary_idtextRequired
Choose the library or use an ID from a previous step.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

On this page