# Get Telephony Configuration By Id

> GET /api/v1/organizations/telephony-configs/{config_id} — request parameters and responses from the Menace Voice API schema.

`GET /api/v1/organizations/telephony-configs/{config_id}`

{/* Generated by scripts/sync_docs_api.mjs. Edit the API schema source to change the contract. */}

See [authentication](/api-reference/authentication) for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

## API contract for documentation tools

Generated from the OpenAPI schema. Do not infer a different parameter type from an example. Authentication headers are alternatives as explained in the authentication guide.

### Parameters

| Name | Location | Type | Required | Description and constraints |
| --- | --- | --- | --- | --- |
| config_id | path | integer | yes |  |
| authorization | header | string or null | no |  |
| X-API-Key | header | string or null | no |  |

### Response 200

Successful Response

application/json: TelephonyConfigurationDetail (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| id | integer | yes |  |
| name | string | yes |  |
| provider | string | yes |  |
| connectivity | string | no | enum: ["api","sip"]; default: "api" |
| is_default_outbound | boolean | yes |  |
| inactive | boolean | no | default: false |
| inactive_since | string or null | no |  |
| inactive_reason | string or null | no |  |
| credentials | object | yes |  |
| sip_connectivity | SIPConnectivityDetails (object) or null | no |  |
| setup_checklist | ProviderSetupChecklist (object) or null | no |  |
| supports_trunks | boolean | no | default: false |
| trunks | array of TrunkResponse (object) | no |  |
| created_at | string | yes | format: "date-time" |
| updated_at | string | yes | format: "date-time" |

### Response 404

Not found

### Response 422

Validation Error

application/json: HTTPValidationError (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| detail | array of ValidationError (object) | no |  |

## OpenAPI

````yaml api-reference/openapi.json get /api/v1/organizations/telephony-configs/{config_id}
openapi: 3.1.0
info:
  title: Menace Voice API
  description: API for Menace Voice agents
  version: 1.0.0
servers:
  - url: https://voice.menaceui.com
    description: Production
  - url: http://localhost:8000
    description: Local development
paths:
  /api/v1/organizations/telephony-configs/{config_id}:
    get:
      tags:
        - main
        - organizations
      summary: Get Telephony Configuration By Id
      operationId: get_telephony_configuration_by_id_api_v1_organizations_telephony_configs__config_id__get
      parameters:
        - name: config_id
          in: path
          required: true
          schema:
            type: integer
            title: Config Id
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: "null"
            title: Authorization
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: "null"
            title: X-Api-Key
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TelephonyConfigurationDetail"
        "404":
          description: Not found
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: "#/components/schemas/ValidationError"
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ProviderSetupChecklist:
      properties:
        ready_for_outbound:
          type: boolean
          title: Ready For Outbound
        outbound_blocked_reason:
          anyOf:
            - type: string
            - type: "null"
          title: Outbound Blocked Reason
        steps:
          items:
            $ref: "#/components/schemas/SetupStep"
          type: array
          title: Steps
        docs_url:
          anyOf:
            - type: string
            - type: "null"
          title: Docs Url
      type: object
      required:
        - ready_for_outbound
        - outbound_blocked_reason
        - steps
      title: ProviderSetupChecklist
      description: >-
        A configuration's setup progress, as computed by its provider.


        ``ready_for_outbound`` is derived rather than reported independently so
        a

        provider cannot claim readiness while leaving a blocking step
        incomplete.
    SIPConnectivityDetails:
      properties:
        provider_display_name:
          type: string
          title: Provider Display Name
        regions:
          items:
            $ref: "#/components/schemas/SIPRegionDetails"
          type: array
          title: Regions
      type: object
      required:
        - provider_display_name
        - regions
      title: SIPConnectivityDetails
      description: Provider-supplied SIP connection details displayed to customers.
    SIPRegionDetails:
      properties:
        region:
          type: string
          title: Region
        inbound_transports:
          items:
            $ref: "#/components/schemas/SIPTransportDetails"
          type: array
          title: Inbound Transports
        outbound_origin_ip:
          type: string
          title: Outbound Origin Ip
      type: object
      required:
        - region
        - inbound_transports
        - outbound_origin_ip
      title: SIPRegionDetails
      description: Inbound and outbound SIP details for one provider region.
    SIPTransportDetails:
      properties:
        transport:
          type: string
          title: Transport
        hostname:
          type: string
          title: Hostname
        port:
          type: integer
          title: Port
        uri:
          type: string
          title: Uri
      type: object
      required:
        - transport
        - hostname
        - port
        - uri
      title: SIPTransportDetails
      description: Connection details for one supported inbound SIP transport.
    SetupStep:
      properties:
        key:
          type: string
          title: Key
        title:
          type: string
          title: Title
        description:
          type: string
          title: Description
        complete:
          type: boolean
          title: Complete
        blocks_outbound:
          type: boolean
          title: Blocks Outbound
          default: false
      type: object
      required:
        - key
        - title
        - description
        - complete
      title: SetupStep
      description: |-
        One thing the customer must do before a configuration can carry calls.

        ``blocks_outbound`` separates "not done yet" from "outbound calls will
        fail". Inbound-only steps are reported so the checklist is complete
        without making them gate the Phone Call button.
    TelephonyConfigurationDetail:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        provider:
          type: string
          title: Provider
        connectivity:
          type: string
          enum:
            - api
            - sip
          title: Connectivity
          default: api
        is_default_outbound:
          type: boolean
          title: Is Default Outbound
        inactive:
          type: boolean
          title: Inactive
          default: false
        inactive_since:
          anyOf:
            - type: string
              format: date-time
            - type: "null"
          title: Inactive Since
        inactive_reason:
          anyOf:
            - type: string
            - type: "null"
          title: Inactive Reason
        credentials:
          additionalProperties: true
          type: object
          title: Credentials
        sip_connectivity:
          anyOf:
            - $ref: "#/components/schemas/SIPConnectivityDetails"
            - type: "null"
        setup_checklist:
          anyOf:
            - $ref: "#/components/schemas/ProviderSetupChecklist"
            - type: "null"
        supports_trunks:
          type: boolean
          title: Supports Trunks
          default: false
        trunks:
          items:
            $ref: "#/components/schemas/TrunkResponse"
          type: array
          title: Trunks
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
        - id
        - name
        - provider
        - is_default_outbound
        - credentials
        - created_at
        - updated_at
      title: TelephonyConfigurationDetail
      description: Body of ``GET /telephony-configs/{id}`` — credentials are masked.
    TrunkResponse:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        enabled:
          type: boolean
          title: Enabled
        settings:
          additionalProperties: true
          type: object
          title: Settings
        phone_number_count:
          type: integer
          title: Phone Number Count
          default: 0
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
        - id
        - name
        - enabled
        - settings
        - created_at
        - updated_at
      title: TrunkResponse
      description: >-
        One carrier path on a configuration.


        ``settings`` is the provider's own trunk schema (validated on write
        against

        ``ProviderSpec.trunk_settings_cls``). The provider-side identifier is

        Dograh's bookkeeping and is not exposed.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
````