Get Tasks

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

import requests

response = requests.post(
    'https://api.ugc.inc/tasks',
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'accountIds': ['acc_123456', 'acc_789012'],
        'taskType': 'edit_profile',
        'startDate': '2024-01-01T00:00:00Z',
        'endDate': '2024-12-31T23:59:59Z'
    }
)

data = response.json()

if data['ok']:
    for task in data['data']:
        print(f"Task {task['id']}: {task['type']} - {task['status']}")

const response = await fetch('https://api.ugc.inc/tasks', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    accountIds: ['acc_123456', 'acc_789012'],
    taskType: 'edit_profile',
    startDate: '2024-01-01T00:00:00Z',
    endDate: '2024-12-31T23:59:59Z'
  })
});

const data = await response.json();

if (data.ok) {
  data.data.forEach(task => {
    console.log(`Task ${task.id}: ${task.type} - ${task.status}`);
  });
}

import { UGCClient } from 'ugcinc';

const client = new UGCClient({
  apiKey: 'YOUR_API_KEY'
});

const response = await client.tasks.getTasks({
  accountIds: ['acc_123456', 'acc_789012'],
  taskType: 'edit_profile',
  startDate: '2024-01-01T00:00:00Z',
  endDate: '2024-12-31T23:59:59Z'
});

if (response.ok) {
  response.data.forEach(task => {
    console.log(`Task ${task.id}:`);
    console.log(`  Type: ${task.type}`);
    console.log(`  Status: ${task.status}`);
    console.log(`  Scheduled: ${task.scheduled_time}`);
  });
}

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

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

string[]

Array of account IDs to filter tasks by

string

Start date in ISO 8601 format (e.g., 2024-01-01T00:00:00Z)

string

End date in ISO 8601 format (e.g., 2024-12-31T23:59:59Z)

TaskType

Filter by specific task typeOptions: warmup_scroll, warmup_search_term, warmup_search_profile, edit_profile, update_posts

Response

Task[]

Array of task objects

Show Task properties

string

Unique task identifier

string

ID of the account this task belongs to

TaskType

Task type

string

Current status: scheduled, pending, complete, or failed

string | null

ISO 8601 timestamp when task should execute

number | null

Task duration in seconds (for warmup tasks)

string | null

Keywords for search tasks (text string)

object | null

Profile update details (for edit_profile tasks)

Show EditProfileInfo properties

string

New avatar URL

string

New display name

string

New bio text

string

ISO 8601 timestamp when task was created

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

import requests

response = requests.post(
    'https://api.ugc.inc/tasks',
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'accountIds': ['acc_123456', 'acc_789012'],
        'taskType': 'edit_profile',
        'startDate': '2024-01-01T00:00:00Z',
        'endDate': '2024-12-31T23:59:59Z'
    }
)

data = response.json()

if data['ok']:
    for task in data['data']:
        print(f"Task {task['id']}: {task['type']} - {task['status']}")

const response = await fetch('https://api.ugc.inc/tasks', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    accountIds: ['acc_123456', 'acc_789012'],
    taskType: 'edit_profile',
    startDate: '2024-01-01T00:00:00Z',
    endDate: '2024-12-31T23:59:59Z'
  })
});

const data = await response.json();

if (data.ok) {
  data.data.forEach(task => {
    console.log(`Task ${task.id}: ${task.type} - ${task.status}`);
  });
}

import { UGCClient } from 'ugcinc';

const client = new UGCClient({
  apiKey: 'YOUR_API_KEY'
});

const response = await client.tasks.getTasks({
  accountIds: ['acc_123456', 'acc_789012'],
  taskType: 'edit_profile',
  startDate: '2024-01-01T00:00:00Z',
  endDate: '2024-12-31T23:59:59Z'
});

if (response.ok) {
  response.data.forEach(task => {
    console.log(`Task ${task.id}:`);
    console.log(`  Type: ${task.type}`);
    console.log(`  Status: ${task.status}`);
    console.log(`  Scheduled: ${task.scheduled_time}`);
  });
}

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

Getting Started

Data Structures

Posts

Comments

Accounts

Statistics

Tasks

Organization

Media

Billing

Automations

Endpoint

Overview

Task Types

Request Body

Response

​Endpoint

​Overview

​Task Types

​Request Body

​Response

Endpoint

Overview

Task Types

Request Body

Response