GET
/
api
/
v1
/
organizations
/
telephony-providers
/
metadata
Get Telephony Providers Metadata
curl --request GET \
  --url https://api.stage.peachdeskai.com/api/v1/organizations/telephony-providers/metadata
{
  "providers": [
    {
      "provider": "<string>",
      "display_name": "<string>",
      "fields": [
        {
          "name": "<string>",
          "label": "<string>",
          "type": "<string>",
          "required": true,
          "sensitive": true,
          "description": "<string>",
          "placeholder": "<string>"
        }
      ],
      "docs_url": "<string>"
    }
  ]
}
Use this endpoint to discover which telephony providers Peachdesk supports and the exact credential fields each one expects. The response drives the configuration form in the dashboard, and is the recommended way to build a provider-agnostic integration.

Headers

​
authorization
string | null
​
X-API-Key
string | null

Response

Successful Response

List of UI form definitions used by the telephony-config screen.

​
providers
TelephonyProviderMetadata · object[]
required