Skip to main content
GET
/
api
/
sms
/
providers
/
config
Get full SMS provider configuration
curl --request GET \
  --url https://your-instance.example.com/api/sms/providers/config \
  --header 'Authorization: Bearer <token>'
{
  "activeProvider": "twilio",
  "providers": [
    {
      "provider": "twilio",
      "isEnabled": true,
      "isConfigured": true,
      "twilioAccountSid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "twilioAuthToken": "••••••••••••••••••••••••••••••••",
      "twilioMessagingServiceSid": "MGxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    },
    {
      "provider": "sinch",
      "isEnabled": false,
      "isConfigured": false
    },
    {
      "provider": "textgrid",
      "isEnabled": false,
      "isConfigured": false
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
organizationId
string

SUPERADMIN-only override of the target organization.

Response

SMS provider configuration

Response from GET /api/sms/providers/config.

​
providers
object[]
required

One entry per supported provider — twilio, sinch, textgrid — regardless of whether it is configured. Frontends iterate this list to render the settings UI.

​
activeProvider
enum<string>

Currently-active provider for the org. May be null even when providers are configured but none has been promoted.

Available options:
twilio,
sinch,
textgrid
Example:

"twilio"