GET
/
v1
/
teams
/
{teamId}
/
social-accounts
/
{id}
/
creator-info
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

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

const response = await client.social.getSocialAccountCreatorInfo({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  id: process.env.OCTOSPARK_ID ?? "id",
})
{
  "socialAccountId": "<string>",
  "creatorNickname": "<string>",
  "creatorUsername": "<string>",
  "creatorAvatarUrl": "<string>",
  "privacyLevelOptions": [
    "<string>"
  ],
  "commentDisabled": true,
  "duetDisabled": true,
  "stitchDisabled": true,
  "maxVideoPostDurationSec": 123,
  "canPost": true,
  "cannotPostReason": "<string>",
  "fetchedAt": "<string>",
  "forceInbox": 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.

id
string
required

Connected social account id (UUID), as returned by the list social accounts endpoint.

Response

Live TikTok creator info for a connected TikTok account, read from TikTok's creator_info endpoint.

Live TikTok creator info for a connected TikTok account, read from TikTok's creator_info endpoint.

socialAccountId
string
required

The connected social account the creator info describes.

creatorNickname
string | null
required

Creator display name from TikTok, shown so the user knows which account receives the post.

creatorUsername
string | null
required

Creator @handle from TikTok.

creatorAvatarUrl
string | null
required

Creator avatar URL from TikTok.

privacyLevelOptions
string[]
required

The privacyLevel values this creator may post with right now. A Direct Post must use one of them.

commentDisabled
boolean
required

True when the creator turned comments off in the TikTok app; the post must disable comments.

duetDisabled
boolean
required

True when the creator turned Duet off in the TikTok app; the post must disable Duet.

stitchDisabled
boolean
required

True when the creator turned Stitch off in the TikTok app; the post must disable Stitch.

maxVideoPostDurationSec
number | null
required

Longest video, in seconds, this creator can post. null when TikTok did not report a limit.

canPost
boolean
required

False when TikTok says the creator cannot post right now (for example a posting cap). Retry later.

cannotPostReason
string | null
required

TikTok error code explaining why canPost is false, or null.

fetchedAt
string
required

ISO-8601 time the creator info was read from TikTok. Responses are cached for a few minutes.

forceInbox
boolean
required

True while Octospark sends every TikTok post to the creator's TikTok inbox (contentPostingMethod UPLOAD) instead of posting directly. schedulePost and postNow then ignore Direct Post settings such as privacyLevel; the creator finishes the post in the TikTok app.