minimusdocs
Help center

Lines

List lines

GET/auth/line-users/

read Read: looks, changes nothing. Scopes

The lines you can see, a page at a time: yours first, then the newest. Each comes with its settings (line_profile), its current package and how many connections it has open.

Query parameters

  • groupinteger

    Only lines in this group.

  • orderingstring

    Which field to use when ordering the results.

  • ownerstring

    The id of the account that created the line, or none for lines with no owner.

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

  • scopestring

    mine: lines you created; subtree: those and the lines of everyone below you; all: every line (for those who may see all lines, otherwise the same as subtree).

    One of: "all" "mine" "subtree"

  • searchstring

    Matches the username, the owner's username or part of the id.

  • statusstring

    active: can watch now; disabled: can't watch and is not banned; online: watching now.

    One of: "active" "banned" "disabled" "expired" "online" "restreamer" "trial"

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
    • usernamestringrequired
    • emailstring (email)can be null
    • first_namestring
    • last_namestring
    • phone_numberstringcan be null
    • phone_country_codestringcan be null
    • is_staffbooleanrequiredread-only

      Designates whether the user can log into this admin site.

    • is_activebooleanrequiredread-only
    • groupsstring[]requiredread-only
    • created_atstring (date-time)requiredread-only
    • updated_atstring (date-time)requiredread-only
    • profileobjectrequiredread-only
      • user_typestring

        Type of user - staff for dashboard access, line for stream access only

        • staff - Staff User
        • line - Line User
        • service - Service Account
      • user_type_displaystringrequiredread-only
      • created_atstring (date-time)requiredread-only
      • updated_atstring (date-time)requiredread-only
    • line_profileobjectrequiredread-onlycan be null
      • statusstring

        Only "Active" can watch. The rest differ in intent, not in effect: "Inactive" is not yet in service, "Suspended" is a reversible hold (payment pending) an automated process may lift, "Banned" is applied for abuse and must never be reversed automatically, "Expired" is driven by the expiry date. Pick the one you would defend to the customer — reporting and any future auto-reactivation read this field.

        • active - Active
        • inactive - Inactive
        • suspended - Suspended
        • banned - Banned
        • expired - Expired
      • status_displaystringrequiredread-only
      • max_connectionsinteger

        Maximum simultaneous connections allowed

      • expire_datestring (date-time)can be null

        Account expiration date

      • allowed_user_agentstring

        Allowed user agents (one per line)

      • allowed_ipsstring

        Allowed IP addresses (one per line, supports CIDR)

      • blocked_ipsstring

        Addresses this line may not be used from (one per line: an address, a CIDR block or a range a-b). Wins over the allowed addresses.

      • notesstring

        Operator-only notes. Hidden from the reseller who owns this line.

      • reseller_notesstring

        The owning reseller's own notes — order references, billing history. Visible to the owner and to anyone above them.

      • is_expiredbooleanrequiredread-only
      • created_atstring (date-time)requiredread-only
      • updated_atstring (date-time)requiredread-only
      • last_activitystring (date-time)requiredread-onlycan be null
      • created_by_usernamestringrequiredread-only
      • bouquetsstring (uuid)[]requiredread-only
      • bouquets_displayobject[]requiredread-only
        • idstring (uuid)required
        • namestringrequired
      • is_trialboolean

        Line was provisioned from a trial package.

      • is_restreamerboolean

        Authorized restream line (relays content downstream).

      • forced_countriesstring

        Comma-separated ISO country codes the line may connect from. Empty = anywhere.

      • lock_to_ispboolean

        Bind the line to the ISP seen on its first connection.

      • locked_ispstringrequiredread-only

        ISP captured on the first connection while lock_to_isp is on.

      • forced_serverstring (uuid)can be null

        Stream only from this server; auto routing is bypassed.

      • forced_server_namestringrequiredread-only
      • output_formatsstring

        Comma-separated delivery formats this line was sold. Not enforced: streams are delivered as MPEG-TS.

      • packageobjectrequiredread-onlycan be null

        The package the line is on now; null when none.

        • idstring (uuid)required
        • namestringrequired
        • is_trialbooleanrequired
        • assigned_atstring (date-time)required
        • expires_atstring (date-time)requiredcan be null
    • active_connectionsintegerrequiredread-only

      Default: 0

    • is_onlinebooleanrequiredread-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