Skip to main content
GET
/
agent-tasks
List Agent Tasks
curl --request GET \
  --url https://api.beamstudio.ai/agent-tasks \
  --header 'current-workspace-id: <current-workspace-id>' \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "tasks": [],
      "groupName": "Completed Tasks",
      "groupId": "completed",
      "groupCount": 25,
      "groupIcon": "check-circle"
    }
  ],
  "totalCount": 150
}

Authorizations

​
x-api-key
string
header
required

Headers

​
current-workspace-id
string
required

Query Parameters

​
pageNum
number
default:1

Page number for pagination

Required range: x >= 1
Example:

1

​
pageSize
number
default:10

Number of items per page

Required range: x >= 1
Example:

10

​
agentId
string

Filter tasks by specific agent ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
statuses
string

Comma-separated list of task statuses to filter by

Example:

"pending,in_progress,completed"

​
searchQuery
string

Search query to filter tasks by name or description

Example:

"email task"

​
ordering
string

Sort order for results. Use field:asc or field:desc format

Example:

"createdAt:desc"

​
startDate
string

Filter tasks created after this date (ISO 8601 format)

Example:

"2024-01-01T00:00:00Z"

​
endDate
string

Filter tasks created before this date (ISO 8601 format)

Example:

"2024-12-31T23:59:59Z"

​
grouping
enum<string>
Available options:
status,
agent

Response

200 - application/json

Tasks retrieved successfully

​
data
object[]
required

Array of grouped task responses

​
totalCount
number
required

Total number of tasks across all groups

Example:

150