Skip to main content
GET
/
voice-ai
/
agents
/
{agentId}
Get Agent
curl --request GET \
  --url https://services.leadconnectorhq.com/voice-ai/agents/{agentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Version: <version>'
{
  "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

Path Parameters

​
agentId
string
required

Unique agent identifier

Example:

"507f1f77bcf86cd799439011"

Query Parameters

​
locationId
string
required

Location ID

Example:

"LOC123456789ABCDEF"

Response

Agent details retrieved successfully

​
id
string
required

Unique identifier for the created agent

Example:

"507f1f77bcf86cd799439011"

​
locationId
string
required

Unique identifier for the location 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

Required range: 180 <= x <= 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

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

5

​
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

​
actions
object[]
required

Raw actions configured for this agent with complete actionParameters structure

Example:
[
  {
    "_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
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

Example:
[]
​
sendPostCallNotificationTo
object

Current post-call notification settings including recipient configuration

​
agentWorkingHours
object[]

Time intervals when the agent accepts calls, organized by day of week

Example:
[]
​
translation
object

Current language translation settings including enablement status and target language

Last modified on March 7, 2026