minimusdocs
Help center

Categories

List categories

GET/settings/categories/

read Read: looks, changes nothing. Scopes

Categories in display order, all at once unless page or page_size is sent. Hidden ones are left out unless include_inactive=1 or is_active is sent. Any signed-in account may read them.

Query parameters

  • include_inactivestring

    Hidden categories too.

    One of: "1" "true"

  • is_activeboolean

    Only shown (true) or only hidden (false) categories.

  • 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

    Part of the name.

  • typestring

    Only categories of this type.

    One of: "custom" "movies" "streams" "tv_shows"

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
    • typestringrequired
      • movies - Movies
      • tv_shows - TV Shows
      • streams - Streams
      • custom - Custom

      One of: "movies" "tv_shows" "streams" "custom"

    • descriptionstringcan be null
    • is_activeboolean
    • orderinteger

      Display order within its type (lowest first).

    • streams_countintegerrequiredread-only
    • movies_countintegerrequiredread-only
    • series_countintegerrequiredread-only
    • primary_countintegerrequiredread-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