Skip to main content
GET
/
voice-ai
/
agents
List Agents
curl --request GET \
  --url https://services.leadconnectorhq.com/voice-ai/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Version: <version>'
{
  "total": 150,
  "page": 2,
  "pageSize": 10,
  "agents": [
    {
      "id": "507f1f77bcf86cd799439011",
      "locationId": "LOC123456789ABCDEF",
      "agentName": "Customer Support Agent",
      "businessName": "Acme Corporation",
      "welcomeMessage": "Hello! Thank you for calling. How can I assist you today?",
      "agentPrompt": "You are a helpful customer service representative.",
      "voiceId": "507f1f77bcf86cd799439011",
      "language": "en-US",
      "patienceLevel": "medium",
      "maxCallDuration": 600,
      "sendUserIdleReminders": true,
      "reminderAfterIdleTimeSeconds": 5,
      "timezone": "America/New_York",
      "isAgentAsBackupDisabled": false,
      "actions": [
        {
          "_id": "507f1f77bcf86cd799439011",
          "actionType": "CALL_TRANSFER",
          "name": "Transfer to Manager",
          "actionParameters": {
            "triggerPrompt": "When caller asks for manager",
            "triggerMessage": "Let me transfer you",
            "transferToType": "number",
            "transferToValue": "+1234567890"
          }
        }
      ],
      "inboundNumber": "+1234567890",
      "numberPoolId": "pool_507f1f77bcf86cd799439011",
      "callEndWorkflowIds": [],
      "sendPostCallNotificationTo": {
        "admins": true,
        "allUsers": false,
        "contactAssignedUser": false,
        "specificUsers": [],
        "customEmails": []
      },
      "agentWorkingHours": [],
      "translation": {
        "enabled": false,
        "language": "es"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Access Token or Private Integration Token

Headers

​
Version
enum<string>
required

API Version

Available options:
2021-04-15

Query Parameters

​
page
number
default:1

Page number starting from 1

Required range: 1 <= x <= 5000
Example:

1

​
pageSize
number
default:10

Number of items per page

Required range: 1 <= x <= 50
Example:

10

​
locationId
string
required

Location ID

​
query
string

Query

Response

Agent list retrieved successfully.

​
total
number
required

Total number of items

Example:

150

​
page
number
required

Page number starting from 1

Example:

2

​
pageSize
number
required

Number of items per page

Example:

10

​
agents
object[]
required
Last modified on March 7, 2026