Skip to main content
GET
/
media
/
subscriptions
/
template
PlexGO
package main

import(
	"context"
	"github.com/LukeHagar/plexgo/models/components"
	"github.com/LukeHagar/plexgo"
	"github.com/LukeHagar/plexgo/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := plexgo.New(
        plexgo.WithAccepts(components.AcceptsApplicationXML),
        plexgo.WithClientIdentifier("abc123"),
        plexgo.WithProduct("Plex for Roku"),
        plexgo.WithVersion("2.4.1"),
        plexgo.WithPlatform("Roku"),
        plexgo.WithPlatformVersion("4.3 build 1057"),
        plexgo.WithDevice("Roku 3"),
        plexgo.WithModel("4200X"),
        plexgo.WithDeviceVendor("Roku"),
        plexgo.WithDeviceName("Living Room TV"),
        plexgo.WithMarketplace("googlePlay"),
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.Subscriptions.GetTemplate(ctx, operations.GetTemplateRequest{
        GUID: plexgo.Pointer("plex://episode/5fc70265c40548002d539d23"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}
{
  "MediaContainer": {
    "identifier": "<string>",
    "offset": 123,
    "size": 123,
    "totalSize": 123,
    "SubscriptionTemplate": [
      {
        "MediaSubscription": [
          {
            "title": "This Episode",
            "type": 123,
            "airingsType": "New Airings Only",
            "createdAt": 123,
            "Directory": {},
            "durationTotal": 123,
            "key": "<string>",
            "librarySectionTitle": "<string>",
            "locationPath": "<string>",
            "MediaGrabOperation": [
              {
                "currentSize": 123,
                "grabberIdentifier": "<string>",
                "grabberProtocol": "<string>",
                "id": "<string>",
                "key": "<string>",
                "mediaIndex": 123,
                "mediaSubscriptionID": 123,
                "Metadata": {
                  "title": "<any>",
                  "type": "<any>",
                  "absoluteIndex": 123,
                  "addedAt": 123,
                  "art": "<any>",
                  "audienceRating": 5,
                  "audienceRatingImage": "<any>",
                  "Autotag": [
                    "<any>"
                  ],
                  "banner": "<any>",
                  "chapterSource": "<any>",
                  "composite": "<any>",
                  "contentRating": "<any>",
                  "Country": [
                    "<any>"
                  ],
                  "Director": [
                    "<any>"
                  ],
                  "duration": 123,
                  "Filter": [
                    "<any>"
                  ],
                  "Genre": [
                    "<any>"
                  ],
                  "grandparentArt": "<string>",
                  "grandparentHero": "<string>",
                  "grandparentKey": "<string>",
                  "grandparentRatingKey": "<string>",
                  "grandparentTheme": "<string>",
                  "grandparentThumb": "<string>",
                  "grandparentTitle": "<string>",
                  "Guid": [
                    "<any>"
                  ],
                  "hero": "<any>",
                  "Image": [
                    "<any>"
                  ],
                  "index": 123,
                  "key": "<any>",
                  "lastViewedAt": 123,
                  "leafCount": 123,
                  "Media": [
                    "<any>"
                  ],
                  "originallyAvailableAt": "<any>",
                  "originalTitle": "<any>",
                  "parentHero": "<string>",
                  "parentIndex": 123,
                  "parentKey": "<string>",
                  "parentRatingKey": "<string>",
                  "parentThumb": "<string>",
                  "parentTitle": "<string>",
                  "primaryExtraKey": "<any>",
                  "prompt": "<string>",
                  "rating": 5,
                  "Rating": [
                    "<any>"
                  ],
                  "ratingCount": 123,
                  "ratingImage": "<any>",
                  "ratingKey": "<any>",
                  "Role": [
                    "<any>"
                  ],
                  "search": true,
                  "secondary": true,
                  "skipChildren": true,
                  "skipParent": true,
                  "Sort": [
                    "<any>"
                  ],
                  "studio": "<any>",
                  "subtype": "<any>",
                  "summary": "<any>",
                  "tagline": "<any>",
                  "theme": "<any>",
                  "thumb": "<any>",
                  "titleSort": "<any>",
                  "updatedAt": 123,
                  "userRating": 5,
                  "viewCount": 123,
                  "viewedLeafCount": 123,
                  "viewOffset": 123,
                  "Writer": [
                    "<any>"
                  ],
                  "year": 123
                },
                "percent": 123,
                "provider": "<string>",
                "status": "inactive"
              }
            ],
            "Playlist": {},
            "Setting": [
              {
                "type": "bool",
                "default": "<string>",
                "advanced": true,
                "enumValues": "<string>",
                "group": "<string>",
                "hidden": true,
                "id": "<string>",
                "label": "<string>",
                "summary": "<string>",
                "value": "<string>"
              }
            ],
            "storageTotal": 123,
            "targetLibrarySectionID": 123,
            "targetSectionLocationID": 123,
            "Video": {},
            "parameters": "<string>",
            "selected": true
          }
        ]
      }
    ]
  }
}

Authorizations

​
X-Plex-Token
string
header
required

Headers

​
accepts
enum<string>
default:application/xml
Available options:
application/json,
application/xml
​
X-Plex-Client-Identifier
string
required
Example:
​
X-Plex-Product
string
Example:
​
X-Plex-Version
string
Example:
​
X-Plex-Platform
string
Example:
​
X-Plex-Platform-Version
string
Example:
​
X-Plex-Device
string
Example:
​
X-Plex-Model
string
Example:
​
X-Plex-Device-Vendor
string
Example:
​
X-Plex-Device-Name
string
Example:
​
X-Plex-Marketplace
string
Example:

Query Parameters

​
guid
string

Response

​
MediaContainer
object