Get a list of phone providers

Retrieve a list of phone providers details set for a Tenant. A list of fields to include or exclude may also be specified.

GET https://{tenantDomain}/api/v2/branding/phone/providers

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    phone "github.com/auth0/go-auth0/management/management/branding/phone"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &phone.ListBrandingPhoneProvidersRequestParameters{
        Disabled: management.Bool(
            true,
        ),
    }
    client.Branding.Phone.Providers.List(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.branding.phone.providers.list({
        disabled: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.branding.phone.providers.list({
        disabled: true,
    });
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/branding/phone/providers \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}/api/v2/branding/phone/providers"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/branding/phone/providers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/branding/phone/providers")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/branding/phone/providers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "providers": [
    {
      "id": "<string>",
      "tenant": "<string>",
      "channel": "phone",
      "disabled": true,
      "configuration": {
        "sid": "<string>",
        "delivery_methods": [],
        "default_from": "<string>",
        "mssid": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

disabled · boolean

Whether the provider is enabled (false) or disabled (true).

Response

200

application/json

Phone providers have been successfully retrieved.

providers · object[]

Show child attributes