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,
    )
}

200

{
  "providers": [
    {
      "id": "<string>",
      "tenant": "<string>",
      "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