List Agents

GET 
/voice-ai/agents

Retrieve a paginated list of agents for given location.

Request

Version stringrequired

API Version

Available optionsv3

page number

Page number starting from 1

Possible values: >= 1 and <= 5000

Default value:1

pageSize number

Number of items per page

Possible values: >= 1 and <= 50

Default value:10

locationId stringrequired

Location ID

query string

Query

application/json

Agent list retrieved successfully.

application/json

Schema

Schema

totalnumberrequired

Total number of items

pagenumberrequired

Page number starting from 1

pageSizenumberrequired

Number of items per page

agentsobject[]required

Example (auto)

{
  "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,
      "inboundNumber": "+1234567890",
      "numberPoolId": "pool_507f1f77bcf86cd799439011",
      "callEndWorkflowIds": [],
      "sendPostCallNotificationTo": {
        "admins": true,
        "allUsers": false,
        "contactAssignedUser": false,
        "specificUsers": [],
        "customEmails": []
      },
      "agentWorkingHours": [],
      "timezone": "America/New_York",
      "isAgentAsBackupDisabled": false,
      "translation": {
        "enabled": false,
        "language": "es"
      },
      "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"
          }
        }
      ]
    }
  ]
}