minimusdocs
Help center

TV shows

List TV shows

GET/tv/series/

read Read: looks, changes nothing. Scopes

The TV shows you may manage, a page at a time, with how many seasons, episodes and playable episodes each has. Resellers see only the TV shows they added.

Query parameters

  • categorystring (uuid)

    Only TV shows in this category.

  • has_tmdbboolean

    Only TV shows matched on TMDB.

  • is_activeboolean

    Only active, or only inactive, TV shows.

  • orderingstring

    Which field to use when ordering the results.

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

  • searchstring

    Matches the name.

Response

200 OK

  • countintegerrequired

    How many there are in all, on every page.

  • nextstring (uri)can be null

    The next page, or null on the last one.

  • previousstring (uri)can be null

    The page before, or null on the first one.

  • resultsobject[]required
    • idstring (uuid)requiredread-only
    • xtream_idintegerrequiredread-only

      The number players know it by, in player links and the player API. Given when it is created, never changed or reused, because players save favourites against it.

    • namestringrequired
    • categorystring (uuid)required

      The one category this show reports as its own where exactly one is allowed: the M3U playlist group of every episode, and the title-uniqueness rule below. Always among categories.

    • category_namestringrequiredread-only
    • categoriesstring (uuid)[]

      Every category this show appears under. Browsing and filtering read this; it always contains category.

    • bouquetsstring (uuid)[]

      Bouquets this show belongs to. A line with none of them in common cannot watch any of its episodes.

    • plotstring
    • poster_urlstring (uri)
    • backdrop_urlstring (uri)
    • trailer_urlstring (uri)
    • yearintegercan be null
    • release_datestring (date)can be null
    • ratingstring (decimal)can be null

      Out of 10.

    • genrestring
    • caststring
    • directorstring

      The show's creators — what TMDB lists for a series instead of a director.

    • countrystring
    • tmdb_idstring

      Set when the show was matched on TMDB. Seasons and episodes are looked up under it, so a sync fills every episode's own metadata without searching again.

    • is_activeboolean

      An inactive show disappears from playlists and refuses playback of every episode, without anything being deleted.

    • sort_orderinteger
    • season_countintegerrequiredread-only
    • episode_countintegerrequiredread-only
    • playable_countintegerrequiredread-only

      Episodes with a file a viewer could be sent to right now — the same reading as an episode's own is_playable, counted in the database by the viewset.

    • created_bystring (uuid)requiredread-onlycan be null
    • created_by_usernamestringrequiredread-only
    • created_atstring (date-time)requiredread-only
    • updated_atstring (date-time)requiredread-only

Errors

  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means