GET
/
v1
/
teams
/
{teamId}
/
caption-settings
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

const client = new OctosparkClient({
  token: process.env.OCTOSPARK_TOKEN
})

const response = await client.captions.getCaptionSettings({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
})
{
  "channels": [
    {
      "firstCommentSupported": true
    }
  ],
  "requireUtmParameters": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
teamId
string
required

Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.

Response

Success

​
channels
object[]
required

The effective link placement for every channel.

​
requireUtmParameters
boolean
required

When true, caption warnings flag CTA links without utm parameters.