Skip to main content

​
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
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"
  }'

{
  "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
    }
  ]
}