---
title: "Get Telephony Providers Metadata"
method: GET
path: "/api/v1/organizations/telephony-providers/metadata"
tags: ["main", "organizations"]
---

# Get Telephony Providers Metadata

`GET /api/v1/organizations/telephony-providers/metadata`

Return the list of available telephony providers and their form schemas.

The UI uses this to render the configuration form generically instead of
hard-coding fields per provider. Adding a new provider only requires
declaring its ui_metadata in providers/<name>/__init__.py.

## Headers

- `authorization` string, nullable
- `X-API-Key` string, nullable

## Response `200`

Successful Response

- TelephonyProvidersMetadataResponse — List of UI form definitions used by the telephony-config screen.
  - `providers` TelephonyProviderMetadata[], required
    - `provider` string, required
    - `display_name` string, required
    - `fields` TelephonyProviderUIField[], required
      - `name` string, required
      - `label` string, required
      - `type` string, required
      - `required` boolean, required
      - `sensitive` boolean, required
      - `description` string, nullable
      - `placeholder` string, nullable
      - `options` TelephonyProviderUIOption[], nullable
        - `value` string, required
        - `label` string, required
      - `visible_when` TelephonyProviderUICondition
        - `field` string, required
        - `equals` unknown, required
      - `section` string, nullable
    - `docs_url` string, nullable

## Other responses

- `404` — Not found
- `422` — Validation Error

---

[API](https://skmtc.net/dograh/apis/dograh-api.md) · [All operations](https://skmtc.net/dograh/apis/dograh-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dograh/dograh-api/versions/e7d045c0295a/schema)