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

# Get Telephony Providers Metadata

> Read provider capabilities and setup fields used by the Telephony dashboard. A listed provider still needs a valid, ready configuration for your account.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/organizations/telephony-providers/metadata
openapi: 3.1.0
info:
  title: Athena API
  version: 1.0.0
  description: >-
    Hosted Athena customer API. Authenticate backend management and call-trigger
    requests with X-API-Key. Website embeds and artifact playback use their own
    scoped tokens. Provider availability, feature settings, and verification
    limits are described in the guides.
servers:
  - url: https://athena.tryopencomputer.com
    description: Hosted Athena API
security: []
paths:
  /api/v1/organizations/telephony-providers/metadata:
    get:
      tags:
        - Organizations
      summary: Get Telephony Providers Metadata
      description: >-
        Read provider capabilities and setup fields used by the Telephony
        dashboard. A listed provider still needs a valid, ready configuration
        for your account.
      operationId: >-
        get_telephony_providers_metadata_api_v1_organizations_telephony_providers_metadata_get
      parameters:
        - 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/TelephonyProvidersMetadataResponse'
        '400':
          description: Bad Request
        '401':
          description: Authentication is missing or invalid.
        '404':
          description: Not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
components:
  schemas:
    TelephonyProvidersMetadataResponse:
      properties:
        providers:
          items:
            $ref: '#/components/schemas/TelephonyProviderMetadata'
          type: array
          title: Providers
      type: object
      required:
        - providers
      title: TelephonyProvidersMetadataResponse
      description: List of UI form definitions used by the telephony-config screen.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    TelephonyProviderMetadata:
      properties:
        provider:
          type: string
          title: Provider
        display_name:
          type: string
          title: Display Name
        connectivity:
          type: string
          enum:
            - api
            - sip
          title: Connectivity
          default: api
        supports_outbound:
          type: boolean
          title: Supports Outbound
          default: true
        fields:
          items:
            $ref: '#/components/schemas/TelephonyProviderUIField'
          type: array
          title: Fields
        docs_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Docs Url
      type: object
      required:
        - provider
        - display_name
        - fields
      title: TelephonyProviderMetadata
      description: UI form metadata for a single telephony provider.
    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
    TelephonyProviderUIField:
      properties:
        name:
          type: string
          title: Name
        label:
          type: string
          title: Label
        type:
          type: string
          title: Type
        required:
          type: boolean
          title: Required
        sensitive:
          type: boolean
          title: Sensitive
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        placeholder:
          anyOf:
            - type: string
            - type: 'null'
          title: Placeholder
        options:
          anyOf:
            - items:
                $ref: '#/components/schemas/TelephonyProviderUIOption'
              type: array
            - type: 'null'
          title: Options
        visible_when:
          anyOf:
            - $ref: '#/components/schemas/TelephonyProviderUICondition'
            - type: 'null'
        section:
          anyOf:
            - type: string
            - type: 'null'
          title: Section
      type: object
      required:
        - name
        - label
        - type
        - required
        - sensitive
      title: TelephonyProviderUIField
      description: One form field on a telephony provider's configuration UI.
    TelephonyProviderUIOption:
      properties:
        value:
          type: string
          title: Value
        label:
          type: string
          title: Label
      type: object
      required:
        - value
        - label
      title: TelephonyProviderUIOption
    TelephonyProviderUICondition:
      properties:
        field:
          type: string
          title: Field
        equals:
          title: Equals
      type: object
      required:
        - field
        - equals
      title: TelephonyProviderUICondition
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
    BearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.