Skip to main content
GET
/
api
/
v1
/
vendors
/
{vendorId}
/
organizations
/
{organizationId}
/
agents
/
{agentId}
/
tasks
List Agent Tasks
curl --request GET \
  --url https://app.phonebot.io:80/api/v1/vendors/{vendorId}/organizations/{organizationId}/agents/{agentId}/tasks
{
  "success": true,
  "page": 0,
  "size": 20,
  "totalElements": 100,
  "totalPages": 5,
  "timestamp": "2025-04-17T14:23:30Z",
  "message": "<string>",
  "data": [
    {
      "id": "77aaddcc-88bb-11ee-aacc-112233445566",
      "userValues": {
        "customer_name": "Alice Wonderland",
        "product_interest": "Teapot",
        "callback_reason": "Price query"
      },
      "targetNumber": "+491721234567"
    }
  ],
  "traceId": "<string>"
}

Path Parameters

vendorId
string
required

ID of the Vendor (UUID)

organizationId
string
required

ID of the Organization (UUID)

agentId
string
required

ID of the Agent (UUID)

Query Parameters

page
integer
default:0

Page number of the requested page (0-indexed)

size
integer
default:20

Number of items per page

sort
string
default:name,asc

Sorting criteria in the format: property,(asc|desc). Default sort is 'name,asc' (Note: Default field 'name' might not exist on Task, adjust if needed). Multiple sort criteria are supported.

Response

Successfully retrieved the list of agent tasks

Paged API response wrapper

success
boolean
required

Indicates if the request was successful

Example:

true

page
integer<int32>
required

Current page number (0-indexed)

Example:

0

size
integer<int32>
required

Size of each page

Example:

20

totalElements
integer<int64>
required

Total number of elements

Example:

100

totalPages
integer<int32>
required

Total number of pages

Example:

5

timestamp
string<date-time>
required

Response timestamp in ISO-8601 format

Example:

"2025-04-17T14:23:30Z"

message
string

Human-readable message

data
object[]

List of data items

traceId
string

Correlation or trace ID