Get Voice Agent API

This documentation explains how to retrieve details of voice agents using the API.

Endpoint

GET /api/v1/global/agents/get or POST /api/v1/global/agents/get

Authentication

Include your API token in the request header:

token: <your_api_token>

api_access_token: <your_api_token>

Request Body (for POST)

Get Specific Agent

{
  "agent_id": 123
}

Get All Agents

{}

Get Agents by Type

{
  "agent_type": 3
}

Get Specific Agent with Type Filter

{
  "agent_id": 123,
  "agent_type": 3
}

Query Parameters (for GET)

Get Specific Agent

?agent_id=123

Get All Agents

(no parameters)

Get Agents by Type

?agent_type=3

Get Specific Agent with Type Filter

?agent_id=123&agent_type=3

Optional Fields

Field	Type	Description
`agent_id`	integer	ID of the agent to retrieve. If not provided, returns all agents
`agent_type`	integer	Filter by agent type. See Agent Types below

Agent Types

ID	Type	Description
2	Chat	Chat-based agents
3	Telephony	Voice/telephony agents (for making calls)
4	General	General purpose agents

Note: For voice/telephony agents that can make calls, use agent_type: 3.

Calling Types

Important: The calling_type field in the response indicates whether the agent is configured for outbound or inbound calls.

ID	Type	Description
1	Outbound	Agent makes calls to customers. The agent initiates calls to phone numbers.
2	Inbound	Agent receives calls from customers. Customers call your phone numbers and the agent answers.
null	Not Set	Calling type is not configured for this agent.

Note:

calling_type: 1 means the agent is configured for outbound calling (making calls)
calling_type: 2 means the agent is configured for inbound calling (receiving calls)
calling_type: null means the calling type is not configured

Success Response

Single Agent Response (when agent_id is provided)

Status Code: 200 OK

{
  "error": false,
  "code": 200,
  "message": "Voice agent retrieved successfully",
  "timestamp": 1767638299411,
  "data": {
    "success": true,
    "message": "Voice agent retrieved successfully",
    "data": {
      "agent_id": 1048,
      "agent_name": "Test Agent",
      "description": "Test description",
      "status": 3,
      "agent_type": 3,
      "voice_id": "KYiVPerWcenyBTIvWbfY",
      "voice_provider": 1,
      "transcriber_provider": null,
      "calling_type": null,
      "created_on": "2026-01-01T07:44:46.000Z",
      "updated_on": "2026-01-01T07:44:46.000Z"
    }
  }
}

Multiple Agents Response (when agent_id is not provided)

Status Code: 200 OK

{
  "error": false,
  "code": 200,
  "message": "Voice agents retrieved successfully",
  "timestamp": 1767638262719,
  "data": {
    "success": true,
    "total": 35,
    "data": [
      {
        "agent_id": 1049,
        "agent_name": "Flow Test",
        "description": "",
        "status": 3,
        "agent_type": 3,
        "voice_id": "KYiVPerWcenyBTIvWbfY",
        "voice_provider": 1,
        "transcriber_provider": null,
        "calling_type": null,
        "created_on": "2026-01-02T14:13:19.000Z",
        "updated_on": "2026-01-02T14:13:19.000Z"
      },
      {
        "agent_id": 1048,
        "agent_name": "Test Agent",
        "description": "",
        "status": 3,
        "agent_type": 3,
        "voice_id": "KYiVPerWcenyBTIvWbfY",
        "voice_provider": 1,
        "transcriber_provider": null,
        "calling_type": null,
        "created_on": "2026-01-01T07:44:46.000Z",
        "updated_on": "2026-01-01T07:44:46.000Z"
      }
    ]
  }
}

Response Fields

Field	Type	Description
`agent_id`	integer	Unique identifier for the agent
`agent_name`	string	Name of the agent
`description`	string	Description of the agent (can be empty string)
`status`	integer	Agent status: 1 = Active, 3 = Inactive, 2 = Deleted
`agent_type`	integer	Type of agent: 2 = Chat, 3 = Telephony, 4 = General
`voice_id`	string	Voice ID being used (can be a string identifier)
`voice_provider`	integer	Voice provider ID (see Create Agent docs for options)
`transcriber_provider`	integer \| null	Speech-to-text provider ID (can be null)
`calling_type`	integer \| null	Calling type (see Calling Types below). Can be null if not configured
`created_on`	string	Creation timestamp (ISO 8601 format)
`updated_on`	string	Last update timestamp (ISO 8601 format)

Note:

transcriber_provider and calling_type can be null if not configured
voice_id is typically a string identifier, not an integer
Timestamps are in ISO 8601 format (e.g., “2026-01-01T07:44:46.000Z”)

Error Responses

400 Bad Request

{
  "error": true,
  "message": "Agent ID is required"
}

401 Unauthorized

{
  "error": true,
  "message": "Invalid Auth Key or Session Expired"
}

404 Not Found

{
  "error": true,
  "message": "Agent not found"
}

Example Requests

Get Specific Agent (GET)

curl -X GET "https://www.tryunleashx.com/api/v1/global/agents/get?agent_id=123" \
  -H "token: your_api_token_here"

Get Specific Agent (POST)

curl -X POST https://www.tryunleashx.com/api/v1/global/agents/get \
  -H "Content-Type: application/json" \
  -H "token: your_api_token_here" \
  -d '{
    "agent_id": 123
  }'

Get All Agents (GET)

curl -X GET "https://www.tryunleashx.com/api/v1/global/agents/get" \
  -H "token: your_api_token_here"

Get All Agents (POST)

curl -X POST https://www.tryunleashx.com/api/v1/global/agents/get \
  -H "Content-Type: application/json" \
  -H "token: your_api_token_here" \
  -d '{}'

Get All Telephony Agents (GET)

curl -X GET "https://www.tryunleashx.com/api/v1/global/agents/get?agent_type=3" \
  -H "token: your_api_token_here"

Get All Telephony Agents (POST)

curl -X POST https://www.tryunleashx.com/api/v1/global/agents/get \
  -H "Content-Type: application/json" \
  -H "token: your_api_token_here" \
  -d '{
    "agent_type": 3
  }'

Get All Chat Agents (POST)

curl -X POST https://www.tryunleashx.com/api/v1/global/agents/get \
  -H "Content-Type: application/json" \
  -H "token: your_api_token_here" \
  -d '{
    "agent_type": 2
  }'

Get All General Agents (POST)

curl -X POST https://www.tryunleashx.com/api/v1/global/agents/get \
  -H "Content-Type: application/json" \
  -H "token: your_api_token_here" \
  -d '{
    "agent_type": 4
  }'

Notes

If agent_id is provided, returns details of that specific agent.
If agent_id is not provided, returns a list of all agents.
If agent_type is provided, filters agents by type (2 = Chat, 3 = Telephony, 4 = General).
The agent_type filter only applies when getting all agents (not when getting a specific agent by ID).
The agents must belong to your workspace.
Deleted agents (status = 2) will not be returned.
Use the status field to check if the agent is active before making calls.
For making calls, use agents with agent_type: 3 (Telephony).
Response includes a wrapper with error, code, message, timestamp, and data fields.
The actual agent data is nested in data.data for single agent, or data.data array for multiple agents.

Headers

token

string

required

API token for authentication

Query Parameters

agent_id

integer

ID of the agent to retrieve. If not provided, returns all agents

agent_type

integer

Filter by agent type: 2 = Chat, 3 = Telephony, 4 = General

Response

Voice agents retrieved successfully

API Documentation

Phone Numbers

Voice AI

Call Logs

Campaigns

​Get Voice Agent API

​Endpoint

​Authentication

​Request Body (for POST)

​Get Specific Agent

​Get All Agents

​Get Agents by Type

​Get Specific Agent with Type Filter

​Query Parameters (for GET)

​Get Specific Agent

​Get All Agents

​Get Agents by Type

​Get Specific Agent with Type Filter

​Optional Fields

​Agent Types

​Calling Types

​Success Response

​Single Agent Response (when agent_id is provided)

​Multiple Agents Response (when agent_id is not provided)

​Response Fields

​Error Responses

​400 Bad Request

​401 Unauthorized

​404 Not Found

​Example Requests

​Get Specific Agent (GET)

​Get Specific Agent (POST)

​Get All Agents (GET)

​Get All Agents (POST)

​Get All Telephony Agents (GET)

​Get All Telephony Agents (POST)

​Get All Chat Agents (POST)

​Get All General Agents (POST)

​Notes

Headers

Query Parameters

Response

Get Voice Agent API

Endpoint

Authentication

Request Body (for POST)

Get Specific Agent

Get All Agents

Get Agents by Type

Get Specific Agent with Type Filter

Query Parameters (for GET)

Get Specific Agent

Get All Agents

Get Agents by Type

Get Specific Agent with Type Filter

Optional Fields

Agent Types

Calling Types

Success Response

Single Agent Response (when agent_id is provided)

Multiple Agents Response (when agent_id is not provided)

Response Fields

Error Responses

400 Bad Request

401 Unauthorized

404 Not Found

Example Requests

Get Specific Agent (GET)

Get Specific Agent (POST)

Get All Agents (GET)

Get All Agents (POST)

Get All Telephony Agents (GET)

Get All Telephony Agents (POST)

Get All Chat Agents (POST)

Get All General Agents (POST)

Notes