Get Tasks by Agent Handle
Agent
Get Tasks by Agent Handle
Retrieve all tasks assigned to a specific agent using its handle
GET
Get Tasks by Agent Handle
Documentation Index
Fetch the complete documentation index at: https://docs.unpod.dev/llms.txt
Use this file to discover all available pages before exploring further.
Get Tasks by Agent Handle
Fetch all tasks assigned to a specific agent/pilot using their handle. This returns full task metadata including user info, input payloads, call output, transcripts, and execution details.Prerequisites: Make sure you have your API Token ready. See Authentication for details.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| agent_handle | string | Yes | Unique handle/identifier of the agent |
You can get the
agent_handle by hitting the Get All Agents API. The handle field in the response is your Agent Handle.Headers
| Name | Type | Required | Description |
|---|---|---|---|
| Authorization | string | Yes | API Key format: Token <token> |
| Content-Type | string | Yes | application/json |
Response Fields
| Field | Type | Description |
|---|---|---|
| count | integer | Total number of tasks |
| status_code | integer | HTTP status code |
| message | string | Response message |
| data | array | Array of task objects |
Task Object Fields
| Field | Type | Description |
|---|---|---|
| _id | string | Internal task document ID |
| thread_id | string | Thread identifier |
| user_info | object | User details (email, full_name) |
| task_id | string | Unique task identifier |
| run_id | string | Parent run identifier |
| task | object | Task definition with objective |
| input | object | Input data for the task |
| output | object | Task output with call details |
| attachments | array | List of attachments |
| assignee | string | Agent handle assigned to the task |
| status | string | Task status: pending, completed, failed |
| execution_type | string | Type of execution: call, email, etc. |
| ref_id | string | Reference ID linking to input data |
| failure_count | integer | Number of failed attempts |
| last_failure_reason | string | Reason for last failure (null if none) |
| retry_attempt | integer | Current retry attempt number |
| last_status_change | string | Timestamp of last status change |
| scheduled_timestamp | string | Scheduled execution timestamp (null if now) |
Output Object Fields
| Field | Type | Description |
|---|---|---|
| call_id | string | Unique call identifier |
| call_end_reason | string | Reason for call ending |
| start_time | string | Call start timestamp |
| end_time | string | Call end timestamp |
| assistant_number | string | Outbound phone number used |
| call_summary | string | AI-generated summary of the call |
| duration | number | Call duration in seconds |
| recording_url | string | URL to call recording |
| transcript | array | Array of conversation messages |
| post_call_data | object | Post-call analysis data |
| call_type | string | Direction of call: outbound, inbound |
| call_status | string | Status of the call: completed, etc. |
Common Error Codes
| Status Code | Description |
|---|---|
| 200 | Success - Data fetched successfully |
| 206 | Partial Content - Business logic error occurred |
| 400 | Bad Request - Invalid parameters provided |
| 401 | Unauthorized - Invalid or missing API token |
| 403 | Forbidden - Access denied to the resource |
| 404 | Not Found - Agent not found |
| 500 | Internal Server Error - Server-side error |
Code Examples
Best Practices
- Agent Handle: Use the exact agent handle from the Get All Agents response
- Transcript Analysis: Use the
transcriptfield in the output for detailed conversation analysis - Retry Logic: Check
failure_countandlast_failure_reasonfor failed tasks to understand issues - Recording Access: Store
recording_urlfrom output for compliance and quality review - Security: Keep API tokens secure and rotate them regularly