Bouquets

List bouquets

GET/management/bouquets/

read Read: looks, changes nothing. Scopes

Bouquets you can see, a page at a time, in display order: every bouquet for a panel operator, those in the packages they sell for a reseller. What a bouquet holds is listed with GET /management/bouquets/{id}/content/.

Query parameters

  • mineboolean

    Only the ones you built yourself.

  • 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
    • namestringrequiredread-only
    • descriptionstringrequiredread-onlycan be null
    • is_activebooleanrequiredread-only
    • orderintegerrequiredread-only

      Display order (lowest first). Ties fall back to name.

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