TikTok

List TikTok accounts

List the TikTok accounts connected to the project, oldest first. Each entry includes its id, display name, username, avatar_url, whether it needs reconnecting (disconnected), created_at, and the agent answering on it. Use the returned id as the inbox_id for the other TikTok endpoints.

GET

https://api.nabrah.ai/api/ext/omni_v2/tiktok/inboxes

curl --request GET \
  --url 'https://api.nabrah.ai/api/ext/omni_v2/tiktok/inboxes' \
  --header 'X-API-Key: <your-api-key>'

{
  "inboxes": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "name": "string",
      "created_at": "2026-01-15T12:00:00.000Z",
      "username": "string",
      "avatar_url": "string",
      "disconnected": false,
      "agent_id": "00000000-0000-4000-8000-000000000000",
      "agent_name": "string"
    }
  ],
  "max_inboxes": 0
}

Where inbox IDs come from

This is the canonical source for inbox_id values used by the other TikTok endpoints.

inboxes[].id

The UUID of each TikTok account. Pass it as inbox_id to the other TikTok endpoints, or as the {inbox_id} path parameter to get one account.

idnameusernameavatar_urlcreated_at

Answering agent

The agent auto-replying on the account, or null when none is assigned.

agent_idagent_name

disconnected

True when the account's access was revoked or expired. Replies are not delivered until someone reconnects it from the platform; its conversations and settings are kept.

disconnected

max_inboxes

How many TikTok accounts the project may connect. Contact support to raise it.

max_inboxes

Connecting accounts

Accounts are connected and reconnected in the platform, because the account owner has to sign in with TikTok in their browser. There is no API for connecting an account.

Authorization

X-API-Keystringheaderrequired

Your workspace API key. Create one in the dashboard under API keys.

Response

200

Successful Response

application/json