> ## Documentation Index
> Fetch the complete documentation index at: https://docs.poly.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a connector by ID



## OpenAPI

````yaml GET /v1/agents/{agentId}/telephony/connectors/{connectorId}
openapi: 3.1.0
info:
  title: PolyAI Agents API
  version: 1.0.11
  description: Manage PolyAI agents, telephony, deployments, and real-time configs.
servers:
  - url: https://api.us.poly.ai
    description: US region
  - url: https://api.eu.poly.ai
    description: EU region
  - url: https://api.uk.poly.ai
    description: UK region
  - url: https://api.studio.poly.ai
    description: Studio region
security:
  - polyApiKey: []
paths:
  /v1/agents/{agentId}/telephony/connectors/{connectorId}:
    parameters:
      - name: agentId
        in: path
        required: true
        schema:
          type: string
      - name: connectorId
        in: path
        required: true
        schema:
          type: string
    get:
      tags:
        - Connectors
      summary: Get a connector by ID
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorResponse'
        '401':
          description: Unauthorized – missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden – insufficient permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                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
components:
  schemas:
    ConnectorResponse:
      description: |-
        A connector: the voice, language, variant, and environment bundle
        that handles incoming calls. Multiple phone numbers can share one
        connector.
      type: object
      properties:
        connectorId:
          description: Unique connector identifier
          type: string
        name:
          description: Connector display name
          type: string
        accountId:
          description: Account this connector belongs to
          type: string
        projectId:
          description: Project this connector belongs to
          type: string
        clientEnv:
          description: Client environment (sandbox, pre-release, live)
          type: string
        variantId:
          description: Assigned variant ID (empty string if unassigned)
          type: string
        asrLangCode:
          description: ASR language code (e.g. en-US)
          type: string
        ttsLangCode:
          description: TTS language code (e.g. en-US)
          type: string
        voiceName:
          description: Google TTS voice name (e.g. en-US-Neural2-A)
          type: string
        disableHandoff:
          description: Whether call handoff is disabled
          type: boolean
      required:
        - connectorId
        - name
        - accountId
        - projectId
        - clientEnv
        - variantId
        - asrLangCode
        - ttsLangCode
        - voiceName
        - disableHandoff
    Error:
      type: object
      description: Standard PolyAI API error envelope.
      required:
        - success
        - error
        - error_id
        - error_code
        - error_message
        - data
      properties:
        success:
          type: boolean
          description: Always false for error responses.
          example: false
        error:
          type: string
          description: Human-readable error message.
        error_id:
          type: string
          description: >-
            Unique request identifier from the X-PolyAI-Correlation-Id header.
            Include this when contacting support.
        error_code:
          type: string
          description: Machine-readable error code in UPPER_SNAKE_CASE.
        error_message:
          type: string
          description: Human-readable error message.
        data:
          nullable: true
          description: Always null for error responses.
  securitySchemes:
    polyApiKey:
      type: apiKey
      in: header
      name: X-API-KEY

````