AgentsVersion: v3

List Agents

GET/voice-ai/agents

Retrieve a paginated list of agents for given location.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:voice-ai-agents.readonly

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request

Headers

Versionstringrequired

API Version

Available optionsv3

Query Parameters

pagenumber

Page number starting from 1

Possible values: >= 1 and <= 5000

Default:1

Example:1

pageSizenumber

Number of items per page

Possible values: >= 1 and <= 50

Default:10

Example:10

locationIdstringrequired

Location ID

querystring

Query

Response

application/json

Agent list retrieved successfully.

totalnumberrequired

Total number of items

Example:150

pagenumberrequired

Page number starting from 1

Example:2

pageSizenumberrequired

Number of items per page

Example:10

agentsobject[]required

agents[].idstringrequired

Unique identifier for the created agent

Example:507f1f77bcf86cd799439011

agents[].locationIdstringrequired

Unique identifier for the location where this agent operates

Example:LOC123456789ABCDEF

agents[].agentNamestringrequired

Display name of the voice AI agent

Example:Customer Support Agent

agents[].businessNamestringrequired

Name of the business this agent represents

Example:Acme Corporation

agents[].welcomeMessagestringrequired

Greeting message spoken when the agent answers calls

Example:Hello! Thank you for calling. How can I assist you today?

agents[].agentPromptstringrequired

Custom instructions defining the agent's behavior

Example:You are a helpful customer service representative.

agents[].voiceIdstringrequired

Identifier for the speech synthesis voice being used

Example:507f1f77bcf86cd799439011

agents[].languagestringrequired

Language code for the agent's speech and understanding

Example:en-US

agents[].patienceLevelstringrequired

Current tolerance level for caller response delays

Example:medium

agents[].maxCallDurationnumberrequired

Maximum call duration in seconds, between 180-900

Possible values: >= 180 and <= 900

Example:600

agents[].sendUserIdleRemindersbooleanrequired

Indicates whether automatic idle reminders are enabled

Example:true

agents[].reminderAfterIdleTimeSecondsnumberrequired

Seconds to wait before sending idle reminders, between 1-20

Possible values: >= 1 and <= 20

Example:5

agents[].inboundNumberstring

Phone number for receiving inbound calls

Example:+1234567890

agents[].numberPoolIdstring

Identifier for the number pool managing this agent's phone allocation

Example:pool_507f1f77bcf86cd799439011

agents[].callEndWorkflowIdsstring[]

Array of workflow IDs triggered automatically when calls end

Example:[]

agents[].sendPostCallNotificationToobject

Current post-call notification settings including recipient configuration

agents[].agentWorkingHoursobject[]

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

agents[].timezonestringrequired

IANA timezone identifier for working hours and scheduling

Example:America/New_York

agents[].isAgentAsBackupDisabledbooleanrequired

Indicates whether this agent is excluded from backup scenarios

Example:false

agents[].translationobject

Current language translation settings including enablement status and target language

agents[].actionsobject[]required

Raw actions configured for this agent with complete actionParameters structure