Get Accounts

Retrieve accounts with optional filters

Endpoint

POST https://api.ugc.inc/accounts

Overview

Retrieve a list of accounts with optional filtering by tag, organization group, or user group. If no filters are provided, returns all accounts for your organization.

Request Body

tag · string

Filter accounts by tag

org_group · string

Filter accounts by organization group

user_group · string

Filter accounts by user group

Response

data · Account[]

Array of account objects matching the filters

Show Account properties

id · string

Unique account identifier

type · string

Account platform type (tiktok or instagram)

tag · string | null

Custom tag for categorization

org_group · string | null

Organization group identifier

user_group · string | null

User group identifier

username · string | null

Account username/handle on the platform

nick_name · string | null

Display name shown on profile

pfp_url · string | null

URL to account’s profile picture

warmup_enabled · boolean | null

Whether warmup tasks are enabled for this account

warmup_version · 'original' | 'v1_smart' | null

Warmup scheduling algorithm version. original uses the standard scheduling logic, v1_smart uses an optimized algorithm with custom flows

description · string | null

Description/interest area for the account. Used by v1_smart warmup for browse tasks

keywords · string | null

Search keywords used for warmup tasks (comma-separated)

profiles · string | null

Profile usernames to search for warmup tasks (comma-separated)

cURL

curl -X POST https://api.ugc.inc/accounts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tag": "influencer",
    "org_group": "group1",
    "user_group": "users1"
  }'

Success Response

{
  "ok": true,
  "code": 200,
  "message": "Success",
  "data": [
    {
      "id": "acc_123456",
      "type": "tiktok",
      "tag": "influencer",
      "org_group": "group1",
      "user_group": "users1",
      "username": "coolcreator",
      "nick_name": "Cool Creator",
      "pfp_url": "https://storage.example.com/avatar.jpg",
      "warmup_enabled": true,
      "warmup_version": "original",
      "description": "health and wellness content",
      "keywords": "fitness,workout,health",
      "profiles": "fitnessguru,healthcoach"
    },
    {
      "id": "acc_789012",
      "type": "instagram",
      "tag": "influencer",
      "org_group": "group1",
      "user_group": "users1",
      "username": "awesome_account",
      "nick_name": "Awesome Account",
      "pfp_url": "https://storage.example.com/avatar2.jpg",
      "warmup_enabled": false,
      "warmup_version": null,
      "description": null,
      "keywords": null,
      "profiles": null
    }
  ]
}