v1

latestOpenAPI 3.1.0MIT2026-07-26134154266.9 KB

List AI phone agents

List all AI phone agents in your organization with full details including name, type, model, voice, language, phone number, and configuration.

get/phone

Response

Default Response

idstring required
org_idstring required
phone_numberstring nullable required
namestring nullable required
type'inbound' | 'outbound' required
languagestring[] required
accentstring nullable required
handoff_phone_numberstring nullable required
speednumber nullable required
interruptibleboolean required
actionIdsstring[] nullable required
instructionsstring[] nullable required
data_collection_fieldsstring[] nullable required
data_collection_webhook_urlstring nullable required
model'oppie-vox' | 'oppie-vox-turbo' | 'oppie-vox-2' | 'oppie-vox-livekit' required
voice_idstring nullable required
first_messagestring nullable required
created_atstring date-time required
updated_atstring date-time required
provider_external_idstring nullable required
{"stackTrail":"components:schemas:PhoneAgentDto:properties:flow:anyOf","oasType":"schema","type":"unknown","nullable":true}
custom_llmstring nullable required
use_org_knowledgebaseboolean required
background_noise_preset'office' | 'bar' | 'city-street' nullable required
recording_enabledboolean required
stt_keytermsstring[] required
stt_model'deepgram/flux-general' | 'deepgram/nova-3' | 'deepgram/nova-3-medical' | 'cartesia/ink-whisper' | 'elevenlabs/scribe_v2_realtime' | 'xai/stt-1' | 'assemblyai/universal-3-5-pro' | 'speechmatics/enhanced' nullable required
tts_speed_pctinteger nullable required
failover_transfer_destination_idstring uuid nullable required