> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.agentphone.ai/api-reference/agents/list-agents-v-1-agents-get/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.agentphone.ai/_mcp/server. # List Agents GET https://api.agentphone.ai/v1/agents List all agents for this account. Reference: https://docs.agentphone.ai/api-reference/agents/list-agents-v-1-agents-get ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Query parameters - `offset` (integer, optional, default: 0) ### Headers - `X-Sub-Account-Id` (string, optional, default: 20) — Target a sub-account. Pass a sub-account ID to scope this request. Omit to use the master account. ## Response ### 200 Successful Response - `data` (list of AgentResponse, required) - `total` (integer, required) ## Errors ### 422 Unprocessable Entity Error Validation Error - `detail` (list of ValidationError, optional) ## Types ### AgentResponse - `id` (string, required) - `name` (string, required) - `description` (string, required, nullable) - `voiceMode` (enum, required) - Allowed values: `webhook`, `hosted` - `voice` (string, required) - `createdAt` (datetime, required) - `enableMessaging` (boolean, optional, default: true) - `modelTier` (enum, optional, default: balanced) - Allowed values: `turbo`, `balanced`, `max` - `systemPrompt` (string, optional, nullable) - `beginMessage` (string, optional, nullable) - `transferNumber` (string, optional, nullable) - `customTools` (list of AgentResponseCustomToolsItems, optional, nullable) - `voicemailMessage` (string, optional, nullable) - `callScreeningIdentity` (string, optional, nullable) - `callScreeningPurpose` (string, optional, nullable) - `sttMode` (enum, optional, default: fast) — Speech-to-text mode. 'fast' optimizes for latency, 'accurate' optimizes for transcription accuracy (~200ms additional latency). - Allowed values: `fast`, `accurate` - `ambientSound` (enum, optional, default: none) — Background ambience to mask synthetic silence between turns. 'none' disables; 'office', 'coffee-shop', 'outdoor' enable a quiet bed. - Allowed values: `none`, `office`, `coffee-shop`, `outdoor` - `denoisingMode` (enum, optional, default: noise-cancellation) — Audio denoising. 'noise-cancellation' (default) handles general noise. 'noise-and-background-speech-cancellation' is more aggressive for callers in cars, cafes, or near TVs. - Allowed values: `noise-cancellation`, `noise-and-background-speech-cancellation` - `maxSilenceMs` (integer, optional, default: 600000) — Hang up the call after this many milliseconds of caller silence. Range 10000 (10s) to 3600000 (1 hour). Default 600000 (10 min). - `voiceSpeed` (double, optional, default: 1) — Voice speed multiplier. Range 0.5 to 2.0. Default 1.0. - `interruptionSensitivity` (double, optional, default: 0.8) — How easily callers can interrupt the agent. Range 0.0 to 1.0. Default 0.8. - `enableBackchannel` (boolean, optional, default: true) — When true, the agent interjects short filler words like 'uh-huh' or 'mhmm' during longer caller utterances. Defaults to true. - `language` (string, optional, default: en-US) — BCP-47 locale that drives the agent's speech recognition and pronunciation. Defaults to 'en-US'. - `numbers` (list of AgentNumberResponse, optional, nullable) ### ValidationError - `loc` (list of ValidationErrorLocItems, required) - `msg` (string, required) - `type` (string, required) ### AgentResponseCustomToolsItems ### AgentNumberResponse - `id` (string, required) - `phoneNumber` (string, required) - `status` (string, required) - `type` (string, optional, default: sms) ### ValidationErrorLocItems ## Examples **Response** ```json { "data": [ { "id": "string", "name": "string", "description": "string", "voiceMode": "webhook", "voice": "string", "createdAt": "2024-01-15T09:30:00Z", "enableMessaging": true, "modelTier": "balanced", "systemPrompt": "string", "beginMessage": "string", "transferNumber": "string", "customTools": [ {} ], "voicemailMessage": "string", "callScreeningIdentity": "string", "callScreeningPurpose": "string", "sttMode": "fast", "ambientSound": "none", "denoisingMode": "noise-cancellation", "maxSilenceMs": 600000, "voiceSpeed": 1, "interruptionSensitivity": 0.8, "enableBackchannel": true, "language": "en-US", "numbers": [ { "id": "string", "phoneNumber": "string", "status": "string", "type": "sms" } ] } ], "total": 1 } ``` **SDK Code** ```python import requests url = "https://api.agentphone.ai/v1/agents" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.agentphone.ai/v1/agents'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.agentphone.ai/v1/agents" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.agentphone.ai/v1/agents") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.agentphone.ai/v1/agents") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.agentphone.ai/v1/agents', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.agentphone.ai/v1/agents"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.agentphone.ai/v1/agents")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```