minimusdocs
Help center

Categories

Get a category

GET/settings/categories/{id}/

read Read: looks, changes nothing. Scopes

Shown or hidden. Any signed-in account may read it.

Path parameters

  • idstring (uuid)required

    A UUID string identifying this Category.

Response

200 OK

  • 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.
  • 404 Nothing with this id, or nothing the account can see.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means