Skip to main content
GET
Read Fallback SMS Config
Everything on the Settings → Fallbacks page is available here, so backup SMS can be set up entirely over the API without opening the dashboard.A backup text goes out when iMessage cannot deliver, for two separate reasons: the send failed technically, or the recipient has no iMessage. Both use the same destination.
Reads the workspace’s current fallback setup. To change it, use PATCH /api/workspace/fallback-config.

Authentication

Pass your workspace API key as a Bearer token, or use a Clerk session token.
There are no query parameters — the workspace comes from your key.

Example

Success (200 OK)

Credentials are never returned. telnyxHasOwnApiKey and telnyxHasOwnPublicKey say only whether a key is stored — the key itself is write-only and cannot be read back.

Response

string
none, ghl, twilio or telnyx. none means no backup text will ever go out.
string
E.164 number backup texts are sent from, and where replies come back to.
boolean
true when sending on your own Telnyx account rather than Tuco’s.
boolean
Whether your own API key is stored.
boolean
Whether your own public key is stored. Without it, replies from leads are rejected as unverified.
boolean
Whether a usable key exists at all — yours or Tuco’s.
boolean
Whether a technical send failure also triggers a backup text, not only “no iMessage”.
string
reschedule or fallback — what happens when a line hits its daily cap.
boolean
Whether a custom webhook destination is configured.
boolean
Whether credential encryption is available on this workspace.
boolean
Same, for the shared secrets store.

Errors