Retrieve a paginated list of agents for given account.

http
GET https://services.leadconnectorhq.com/voice-ai/agents

Authorization

NameTypeRequiredExampleDescription
AuthorizationstringYesBearer token generated from the Leadway portal. See Authentication.
VersionstringYes2021-07-28API version.

Query parameters

NameTypeRequiredExampleDescription
pagenumberNo1Page number starting from 1
pageSizenumberNo10Number of items per page
locationIdstringYesAccount ID
querystringNoQuery

Responses

200 - 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)

    • id (string, required): Unique identifier for the created agent Example: 507f1f77bcf86cd799439011

    • locationId (string, required): Unique identifier for the account where this agent operates Example: LOC123456789ABCDEF

    • agentName (string, required): Display name of the voice AI agent Example: Customer Support Agent

    • businessName (string, required): Name of the business this agent represents Example: Acme Corporation

    • welcomeMessage (string, required): Greeting message spoken when the agent answers calls Example: Hello! Thank you for calling. How can I assist you today?

    • agentPrompt (string, required): Custom instructions defining the agent's behavior Example: You are a helpful customer service representative.

    • voiceId (string, required): Identifier for the speech synthesis voice being used Example: 507f1f77bcf86cd799439011

    • language (string, required): Language code for the agent's speech and understanding Example: en-US

    • patienceLevel (string, required): Current tolerance level for caller response delays Example: medium

    • maxCallDuration (number, required): Maximum call duration in seconds, between 180-900 Example: 600

    • sendUserIdleReminders (boolean, required): Indicates whether automatic idle reminders are enabled Example: True

    • reminderAfterIdleTimeSeconds (number, required): Seconds to wait before sending idle reminders, between 1-20 Example: 5

    • inboundNumber (string): Phone number for receiving inbound calls Example: +1234567890

    • numberPoolId (string): Identifier for the number pool managing this agent's phone allocation Example: pool_507f1f77bcf86cd799439011

    • callEndWorkflowIds (string[]): Array of workflow IDs triggered automatically when calls end

    • sendPostCallNotificationTo (object): Current post-call notification settings including recipient configuration

    • agentWorkingHours (object[]): Time intervals when the agent accepts calls, organized by day of week

      • dayOfTheWeek (number, required): Day of the week for this working hours configuration (Monday=1 to Sunday=7) Possible values: 1, 2, 3, 4, 5, 6, 7 Example: 1

      • intervals (object[], required): Array of time intervals when the agent is available on this day

        • startHour (number, required): Starting hour of the working interval in 24-hour format (0-23) Example: 9

        • endHour (number, required): Ending hour of the working interval in 24-hour format (0-23) Example: 17

        • startMinute (number, required): Starting minute of the working interval (0-59) Example: 0

        • endMinute (number, required): Ending minute of the working interval (0-59) Example: 30

    • timezone (string, required): IANA timezone identifier for working hours and scheduling Example: America/New_York

    • isAgentAsBackupDisabled (boolean, required): Indicates whether this agent is excluded from backup scenarios Example: False

    • translation (object): Current language translation settings including enablement status and target language

    • actions (object[], required): Raw actions configured for this agent with complete actionParameters structure

      • id (string, required): Unique identifier for this action Example: 507f1f77bcf86cd799439011

      • actionType (string, required): Type of action Possible values: 'CALL_TRANSFER', 'DATA_EXTRACTION', 'IN_CALL_DATA_EXTRACTION', 'WORKFLOW_TRIGGER', 'SMS', 'APPOINTMENT_BOOKING', 'CUSTOM_ACTION', 'KNOWLEDGE_BASE' Example: CALL_TRANSFER

      • name (string, required): Human-readable name for this action Example: Transfer to Manager

      • actionParameters (object, required): Action parameters - structure varies by actionType

json
{
  "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": [],
      "agentWorkingHours": [],
      "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"
          }
        }
      ]
    }
  ]
}
400 - Bad Request
json
{}
401 - Unauthorized
json
{}
422 - Unprocessable Entity
json
{}

Example

curl -X GET 'https://services.leadconnectorhq.com/voice-ai/agents' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

Last updated October 26, 2026

Was this page helpful?