---
title: "List Board Tasks"
method: GET
path: "/boards/tasks/list"
tags: ["Board Tasks"]
---

# List Board Tasks

`GET /boards/tasks/list`

Get a paginated list of tasks within a Board. Supports filtering by media type, rating, tool category, tool type, and sorting.

## Query parameters

- `boardId` string, required
- `pageNo` integer
- `pageSize` integer
- `mediaType` 'all' | 'image' | 'video' | 'audio'
- `rating` 'all' | '0' | '1' | '2' | '3' | 'unrated'
- `toolCategory` 'image' | 'video' | 'avatar' | 'voice' | 'music'
- `toolType` string
- `sortField` 'gmtCreate' | 'gmtModify' | 'completedAt'
- `sortOrder` 'asc' | 'desc'

## Headers

- `Topview-Uid` string, required
- `Authorization` string, required

## Response `200`

List of tasks retrieved successfully

- object
  - `code` string
  - `message` string
  - `result` object
    - `list` BoardTaskDTO[]
      - `taskId` string — Task business ID
      - `boardTaskId` string — Board task ID
      - `boardId` string — Board ID
      - `sortWeight` number — Sort weight
      - `uid` string — Creator user ID
      - `userName` string — Creator name
      - `toolType` string — Tool type
      - `toolCategory` string — Tool category
      - `status` 'init' | 'running' | 'success' | 'fail' — Task status
      - `mediaType` string — Media type (image/video/audio)
      - `rating` integer, nullable — Rating (0-3)
      - `parameters` object, nullable — Task input parameters
      - `result` object, nullable — Task result
      - `errorMessage` string, nullable — Error message if task failed
      - `errorCode` string, nullable — Error code
      - `creditsCost` integer, nullable — Credits consumed
      - `creditsPayerUid` string, nullable — Credits payer user ID
      - `creditsPayerName` string, nullable — Credits payer name
      - `gmtCreate` string, date-time, nullable — Creation timestamp
      - `gmtModify` string, date-time, nullable — Last modification timestamp
      - `completedAt` string, date-time, nullable — Completion timestamp
      - `isPinned` boolean, nullable — Whether task is pinned
      - `pinnedOriginalSortWeight` number, nullable — Original sort weight before pinning
      - `groupIds` string[], nullable — Group ID list
      - `unresolvedCount` integer, nullable — Number of unresolved comments
      - `useUnlimitMode` boolean, nullable — Whether using Unlimited mode
      - `estimateInfo` QueueEstimateDTO, nullable
        - `queueCount` integer, nullable — Number of tasks in queue (excluding self)
        - `estimatedWaitSeconds` integer, nullable — Estimated wait time in seconds
        - `estimatedProcessSeconds` integer, nullable — Estimated processing time in seconds
    - `total` integer
    - `pageNo` integer
    - `pageSize` integer

## Other responses

- `400` — Invalid parameters
- `401` — Unauthorized
- `500` — Internal server error

---

[API](https://skmtc.net/topview/apis/image-character-swap-apis-editable-in-readme.md) · [All operations](https://skmtc.net/topview/apis/image-character-swap-apis-editable-in-readme/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/topview/image-character-swap-apis-editable-in-readme/revisions/83cd46ca7859/schema)