Studio Captions

List user's studio captions

Info

Required scope: studio.read

Warning

This method requires authentication

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

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

Query Parameters

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

Filter by brand

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

Response

Success
Error
{
  "captions": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "text": "Welcome to the stream!",
      "secondaryText": "Follow for more content",
      "brandId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "text": "Thanks for watching!",
      "secondaryText": null,
      "brandId": null
    }
  ]
}