Get Account Status

Get account status and pending tasks

Endpoint

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

Overview

Retrieve the status and pending tasks for one or more accounts. Use this endpoint to check what tasks are scheduled, pending, or completed for your accounts.

Request Body

accountIds · string[]

Array of account IDs to check status for. Omit to get all accounts.

includeCompleted · boolean · default: false

Include completed tasks in the response

Response

data · AccountTask[]

Array of account task objects

Show AccountTask properties

id · string

Unique task identifier

account_id · string

ID of the account this task belongs to

type · string

Task type (e.g., edit_profile, warmup_scroll)

status · string

Current task status (scheduled, pending, complete, failed)

scheduled_time · string | null

ISO 8601 timestamp when task is scheduled to execute

edit_profile_info · object | null

Profile update information (only for edit_profile tasks)

Show EditProfileInfo properties

avatarUrl · string

New avatar URL

nickName · string

New display name

bio · string

New bio text

created_at · string

ISO 8601 timestamp when task was created

cURL

curl -X POST https://api.ugc.inc/accounts/status \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "accountIds": ["acc_123456", "acc_789012"],
    "includeCompleted": false
  }'

Success Response

{
  "ok": true,
  "code": 200,
  "message": "Success",
  "data": [
    {
      "id": "task_abc123",
      "account_id": "acc_123456",
      "type": "edit_profile",
      "status": "scheduled",
      "scheduled_time": "2024-12-31T12:00:00Z",
      "edit_profile_info": {
        "nickName": "New Display Name",
        "bio": "Updated bio text"
      },
      "created_at": "2024-12-25T10:00:00Z"
    },
    {
      "id": "task_def456",
      "account_id": "acc_789012",
      "type": "warmup_scroll",
      "status": "pending",
      "scheduled_time": "2024-12-26T15:00:00Z",
      "edit_profile_info": null,
      "created_at": "2024-12-25T11:00:00Z"
    }
  ]
}