List Voice Agents

Retrieve a comprehensive list of voice AI agents in your workspace. The response includes agent configurations, integrated tools, execution statistics, AI usage metrics, and creator information.

Overview

The List Voice Agents API returns detailed information about all voice agents in your workspace, including:

Agent basic information (name, type, category, status)
Agent configuration and settings
Integrated tools and subagents
Execution statistics (total, completed, running, failed)
AI usage metrics (tokens, requests, models used)
Creator information
Last modification date

Endpoint

GET /voice-agent/all or GET /list Base URL: https://api.tryunleashx.com/v1 Authentication: Required (Bearer token)

Request Parameters

All parameters are optional. Use them to filter the results.

Parameter	Type	Description
`name`	string	Filter agents by name (partial match, case-insensitive). Example: `name=support` matches “Customer Support Agent”, “Support Bot”, etc.
`status`	integer	Filter by agent status. Common values: `1` = active, `2` = deleted. If not provided, deleted agents are excluded by default.
`agent_type`	integer	Filter by agent type (1, 2, etc.). If not provided, agents with type 3 are excluded by default.
`category`	integer	Filter by category ID. Categories help organize agents by purpose (e.g., Customer Experience, Sales, Support).
`fromdate`	date	Start date for date range filter. Must be used with `todate`. Format: `YYYY-MM-DD`.
`todate`	date	End date for date range filter. Must be used with `fromdate`. Format: `YYYY-MM-DD`.
`date_field`	string	Which date field to filter on. Options: `'created'` (creation date), `'updated'` (update date), or `'both'` (default - either field).

Request Examples

Get All Agents

curl -X GET https://api.tryunleashx.com/v1/voice-agent/all \
  -H "Authorization: Bearer YOUR_API_KEY"

Search by Name

curl -X GET "https://api.tryunleashx.com/v1/voice-agent/all?name=support" \
  -H "Authorization: Bearer YOUR_API_KEY"

Filter by Status and Category

curl -X GET "https://api.tryunleashx.com/v1/voice-agent/all?status=1&category=3" \
  -H "Authorization: Bearer YOUR_API_KEY"

Filter by Date Range

curl -X GET "https://api.tryunleashx.com/v1/voice-agent/all?fromdate=2024-01-01&todate=2024-01-31&date_field=created" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Success Response

Status Code: 200 OK

{
  "data": [
    {
      "ID": 123,
      "AGENT_NAME": "Customer Support Agent",
      "AGENT_TYPE": 1,
      "CATEGORY": 3,
      "STATUS": 1,
      "AGENT_TOKEN": "token_abc123",
      "AGENT_UID": "uid_xyz789",
      "category_description": {
        "id": 3,
        "label": "Customer Experience",
        "textColor": "#003366",
        "backgroundColor": "#E6F7FF"
      },
      "LAST_MODIFIED": "2 days ago",
      "tools_data": {
        "tools": [
          {
            "integration_id": 7,
            "integration_name": "Gmail",
            "service_name": "Gmail API",
            "is_available": true,
            "is_connected": true,
            "is_enabled": true,
            "connected_account": "[email protected]",
            "connected_account_id": "acc_123",
            "category": "Communication",
            "icon": "https://aws-url.com/icons/gmail.png",
            "integration_url": "https://gmail.com",
            "integration_type": "api",
            "auth_type": "oauth"
          }
        ],
        "subagents": [
          {
            "id": 456,
            "name": "Lead Qualification Agent",
            "token": "token_sub456",
            "agent_uid": "uid_sub456",
            "is_enabled": true
          }
        ]
      },
      "creator": {
        "user_id": 789,
        "first_name": "John",
        "last_name": "Doe",
        "email": "[email protected]",
        "full_name": "John Doe"
      },
      "execution_statistics": {
        "total_executions": 150,
        "completed_executions": 120,
        "running_executions": 5,
        "failed_executions": 25,
        "total_minutes": 450
      },
      "ai_usage": {
        "total_tokens_used": 50000,
        "prompt_tokens": 30000,
        "completion_tokens": 20000,
        "total_requests": 100,
        "models_used": ["gpt-4", "gpt-3.5-turbo"],
        "request_types": ["text", "call", "chat"]
      },
      "configuration": {
        // Agent configuration object
      }
    }
  ]
}

Response Fields

Agent Object

Field	Type	Description
`ID`	integer	Unique identifier for the agent
`AGENT_NAME`	string	Name of the agent
`AGENT_TYPE`	integer	Type of agent (1, 2, etc.)
`CATEGORY`	integer	Category ID for organizing agents
`STATUS`	integer	Agent status (1 = active, 2 = deleted)
`AGENT_TOKEN`	string	Authentication token for the agent
`AGENT_UID`	string	Unique identifier for the agent
`category_description`	object	Category details with label and colors
`LAST_MODIFIED`	string	Human-readable last modification time (e.g., “2 days ago”, “Just now”)
`tools_data`	object	Integrated tools and subagents information
`creator`	object	Information about who created the agent
`execution_statistics`	object	Execution metrics and performance data
`ai_usage`	object	AI/LLM usage metrics
`configuration`	object	Agent configuration settings

Category Description Object

Field	Type	Description
`id`	integer	Category ID
`label`	string	Category label (e.g., “Customer Experience”)
`textColor`	string	Text color hex code for UI display
`backgroundColor`	string	Background color hex code for UI display

Tools Data Object

Field	Type	Description
`tools`	array	Array of integrated tool objects
`subagents`	array	Array of subagent objects

Tool Object

Field	Type	Description
`integration_id`	integer	Unique identifier for the integration
`integration_name`	string	Name of the integration (e.g., “Gmail”)
`service_name`	string	Service name (e.g., “Gmail API”)
`is_available`	boolean	Whether the integration is available
`is_connected`	boolean	Whether the integration is connected to an account
`is_enabled`	boolean	Whether the tool is enabled for this agent
`connected_account`	string or null	Connected account name/email
`connected_account_id`	string or null	Connected account identifier
`category`	string	Integration category (e.g., “Communication”)
`icon`	string	URL to the integration icon
`integration_url`	string	URL to the integration service
`integration_type`	string	Type of integration (e.g., “api”)
`auth_type`	string	Authentication type (e.g., “oauth”, “noAuth”)

Subagent Object

Field	Type	Description
`id`	integer	Subagent ID
`name`	string	Subagent name
`token`	string	Subagent authentication token
`agent_uid`	string	Subagent unique identifier
`is_enabled`	boolean	Whether the subagent is enabled

Creator Object

Field	Type	Description
`user_id`	integer	User ID of the creator
`first_name`	string	Creator’s first name
`last_name`	string	Creator’s last name
`email`	string	Creator’s email address
`full_name`	string	Creator’s full name or “Unknown User”

Execution Statistics Object

Field	Type	Description
`total_executions`	integer	Total number of executions
`completed_executions`	integer	Number of successfully completed executions
`running_executions`	integer	Number of currently running executions
`failed_executions`	integer	Number of failed executions
`total_minutes`	integer	Total execution duration in minutes (rounded)

AI Usage Object

Field	Type	Description
`total_tokens_used`	integer	Total tokens used across all models
`prompt_tokens`	integer	Total prompt tokens consumed
`completion_tokens`	integer	Total completion tokens generated
`total_requests`	integer	Total number of AI requests made
`models_used`	array	List of AI models used (e.g., [“gpt-4”, “gpt-3.5-turbo”])
`request_types`	array	List of request types (e.g., [“text”, “call”, “chat”])

Filtering Details

Name Filter

When you provide a name parameter, the API performs a case-insensitive partial match search:

name=support matches: “Customer Support Agent”, “Support Bot”, “Technical Support”
The search looks for the term anywhere in the agent name

Status Filter

status=1 - Returns only active agents
status=2 - Returns only deleted agents
If not provided, deleted agents (status 2) are excluded by default

Agent Type Filter

If agent_type is provided, only agents of that type are returned
If not provided, agents with type 3 are excluded by default

Categories help organize agents by purpose. Common categories include:

Customer Experience
Sales
Support
Marketing
Operations

Date Range Filter

You can filter agents by creation or update date:

Created Date Only: date_field=created
Updated Date Only: date_field=updated
Either Date (Default): date_field=both

Both fromdate and todate must be provided for date filtering to work.

Sorting

Results are sorted by creation date in descending order (most recently created agents first).

Best Practices

Use Filters: Apply filters to reduce result set size and improve response time
Pagination: For large workspaces, consider implementing pagination on the client side
Cache Results: Cache agent lists when appropriate, as they don’t change frequently
Error Handling: Always check response status and handle errors appropriately
Statistics: Execution and AI usage statistics are aggregated efficiently in the response

Performance Considerations

Statistics are aggregated efficiently in bulk queries
Results are processed in parallel for better performance
Large result sets may take longer to process
Consider using filters to limit the number of agents returned

Example Use Cases

Get All Active Agents

curl -X GET "https://api.tryunleashx.com/v1/voice-agent/all?status=1" \
  -H "Authorization: Bearer YOUR_API_KEY"

Find Support Agents Created This Month

curl -X GET "https://api.tryunleashx.com/v1/voice-agent/all?name=support&fromdate=2024-01-01&todate=2024-01-31&date_field=created" \
  -H "Authorization: Bearer YOUR_API_KEY"

Get Agents in Customer Experience Category

curl -X GET "https://api.tryunleashx.com/v1/voice-agent/all?category=3" \
  -H "Authorization: Bearer YOUR_API_KEY"

Notes

Deleted agents (status = 2) are excluded by default unless explicitly requested
Agent type 3 is excluded by default unless explicitly filtered
Last modified date considers updates to agent, configuration, tools, and denied words
Tools and subagents are only included if they are active (status = 1)
Execution duration is accumulated across all status groups and converted to minutes
Category descriptions are automatically parsed from stored data

Create Voice Agent: Create a new voice agent
Update Voice Agent: Modify an existing agent
Delete Voice Agent: Remove an agent
Get Agent Activity Logs: View detailed execution logs for an agent

API Documentation

Agents

Voice AI

Phone Numbers

Voices

Call Logs

Chatbots

Forms

Workflows

Workspaces

Users

​List Voice Agents

​Overview

​Endpoint

​Request Parameters

​Request Examples

​Get All Agents

​Search by Name

​Filter by Status and Category

​Filter by Date Range

​Response

​Success Response

​Response Fields

​Agent Object

​Category Description Object

​Tools Data Object

​Tool Object

​Subagent Object

​Creator Object

​Execution Statistics Object

​AI Usage Object

​Filtering Details

​Name Filter

​Status Filter

​Agent Type Filter

​Category Filter

​Date Range Filter

​Sorting

​Best Practices

​Performance Considerations

​Example Use Cases

​Get All Active Agents

​Find Support Agents Created This Month

​Get Agents in Customer Experience Category

​Notes

​Related Operations