Skip to main content
GET
/
v1
/
agents
/
{agentId}
/
telephony
/
connectors
/
{connectorId}
Get a connector by ID
curl --request GET \
  --url https://api.us.poly.ai/v1/agents/{agentId}/telephony/connectors/{connectorId} \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api.us.poly.ai/v1/agents/{agentId}/telephony/connectors/{connectorId}"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.us.poly.ai/v1/agents/{agentId}/telephony/connectors/{connectorId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.us.poly.ai/v1/agents/{agentId}/telephony/connectors/{connectorId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.us.poly.ai/v1/agents/{agentId}/telephony/connectors/{connectorId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.us.poly.ai/v1/agents/{agentId}/telephony/connectors/{connectorId}")
  .header("X-API-KEY", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.us.poly.ai/v1/agents/{agentId}/telephony/connectors/{connectorId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "connectorId": "<string>",
  "name": "<string>",
  "accountId": "<string>",
  "projectId": "<string>",
  "clientEnv": "<string>",
  "variantId": "<string>",
  "asrLangCode": "<string>",
  "ttsLangCode": "<string>",
  "voiceName": "<string>",
  "disableHandoff": true
}
{
  "success": false,
  "error": "<string>",
  "error_id": "<string>",
  "error_code": "<string>",
  "error_message": "<string>",
  "data": "<unknown>"
}
{
  "success": false,
  "error": "<string>",
  "error_id": "<string>",
  "error_code": "<string>",
  "error_message": "<string>",
  "data": "<unknown>"
}
{
  "success": false,
  "error": "Connector ID does not exist.",
  "error_id": "550e8400-e29b-41d4-a716-446655440000",
  "error_code": "CONNECTORS_NOT_FOUND",
  "error_message": "Connector ID does not exist.",
  "data": null
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
agentId
string
required
​
connectorId
string
required

Response

Successful response

A connector: the voice, language, variant, and environment bundle that handles incoming calls. Multiple phone numbers can share one connector.

​
connectorId
string
required

Unique connector identifier

​
name
string
required

Connector display name

​
accountId
string
required

Account this connector belongs to

​
projectId
string
required

Project this connector belongs to

​
clientEnv
string
required

Client environment (sandbox, pre-release, live)

​
variantId
string
required

Assigned variant ID (empty string if unassigned)

​
asrLangCode
string
required

ASR language code (e.g. en-US)

​
ttsLangCode
string
required

TTS language code (e.g. en-US)

​
voiceName
string
required

Google TTS voice name (e.g. en-US-Neural2-A)

​
disableHandoff
boolean
required

Whether call handoff is disabled

Last modified on April 22, 2026