Skip to main content

Endpoint

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

Overview

Retrieve tasks including warmup activities (scrolling, searching) and profile edit tasks. Use this endpoint to monitor and track all scheduled and completed tasks for your accounts.

Task Types

  • warmup_scroll - Account scrolling warmup activity
  • warmup_search_term - Search term warmup activity
  • warmup_search_profile - Profile search warmup activity
  • edit_profile - Profile update task (nickname, avatar, bio)
  • update_posts - Post update task

Request Body

accountIds
string[]
Array of account IDs to filter tasks by
startDate
string
Start date in ISO 8601 format (e.g., 2024-01-01T00:00:00Z)
endDate
string
End date in ISO 8601 format (e.g., 2024-12-31T23:59:59Z)
taskType
TaskType
Filter by specific task typeOptions: warmup_scroll, warmup_search_term, warmup_search_profile, edit_profile, update_posts

Response

data
Task[]
Array of task objects
curl -X POST https://api.ugc.inc/tasks \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "accountIds": ["acc_123456", "acc_789012"],
    "taskType": "edit_profile",
    "startDate": "2024-01-01T00:00:00Z",
    "endDate": "2024-12-31T23:59:59Z"
  }'
{
  "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",
      "duration": null,
      "keywords": null,
      "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": "complete",
      "scheduled_time": "2024-12-26T15:00:00Z",
      "duration": 300,
      "keywords": null,
      "edit_profile_info": null,
      "created_at": "2024-12-25T11:00:00Z"
    }
  ]
}