List Tickers

List user's studio tickers

Info

Required scope: studio.read

Warning

This method requires authentication

Retrieve a list of all studio tickers belonging to the authenticated user.

Tickers can optionally be linked to a brand via the brandId field. When brandId is null, the ticker is not associated with any brand.

Query Parameters

ParameterTypeDescription
brandIdstring (UUID)Optional. Filter tickers by brand ID. When provided, only tickers belonging to the specified brand are returned.
curl -H "Authorization: Bearer [access token]" \
     https://api.restream.io/v2/user/studio/tickers

Filter by brand

curl -H "Authorization: Bearer [access token]" \
     "https://api.restream.io/v2/user/studio/tickers?brandId=f47ac10b-58cc-4372-a567-0e02b2c3d479"

Response

Success
Error
{
  "tickers": [
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
      "text": "Follow us on Twitter @restream",
      "brandId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    },
    {
      "id": "d4e5f6a7-b8c9-0123-def4-567890123456",
      "text": "Subscribe for more content!",
      "brandId": null
    }
  ]
}